Docs › Getting started › Install the agent
Install the agent
The agent is a small signed program that connects one server to your Console. It dials out over HTTPS, so no ports need to open. It takes about a minute.
Supported systems
| System | Versions | CPU | Notes |
|---|---|---|---|
| Ubuntu | 22.04, 24.04 | amd64, arm64 | Tier 1 |
| Debian | 12, 13 | amd64, arm64 | Tier 1, also for hosting servers |
| Proxmox VE | 8, 9 | amd64 | Host view of guests is coming |
| AlmaLinux, Rocky Linux | 9 | amd64 | Tier 2 |
Steps
- Get an enrolment tokenIn the Console open Servers › Add a server, name the server and choose what the Console may do. The token works once, for 60 minutes.
- Run the installer as rootIt downloads the signed release, checks the signature against our release key, installs the agent and its helper, and asks for the token.curl -fsSL https://get.serverplanet.co.uk/agent | sudo sh -s -- --name web-01 # or, with the token in a file only root can read: curl -fsSL https://get.serverplanet.co.uk/agent | sudo sh -s -- --name web-01 --token-file /root/sp-token
- Check the installer yourself (optional)Compare its SHA-256 with the value shown in the Console and published at get.serverplanet.co.uk/agent.sha256.curl -fsSL https://get.serverplanet.co.uk/agent -o agent && sha256sum agent
- Trust your passkeys on the serverDestructive actions are refused until the server trusts at least one passkey. Compare the fingerprints it prints with the Passkeys page in the Console.sudo spagent approvers trust
- Remove it any timeStops the agent and deletes its files. Your services are not touched.sudo spagent uninstall
Do not pass the token with
--token on the command line: it ends up in your shell history. Paste it at the prompt or use --token-file.policy.toml: your server sets the limits
The file /etc/spagent/policy.toml belongs to you. Whatever the Console asks, the agent refuses anything this file does not allow. A missing or broken file means read-only.
mode = "control" # control | readonly | disconnected
[actions]
services = true
processes = true
power = true
updates = true
[terminal]
safe = true
full = false # full shell: also needs the owner to switch it on with a passkey
root = false # root shell: a further opt-in
[approval]
require_passkey = true # destructive actions need a passkey tap, verified on this server
[hosting]
driver = "hestia" # hestia | spcore | none
To stop every action at once, run sudo spagent lockdown readonly (or disconnected) on the server; sudo spagent lockdown off undoes it. The Console cannot override it. After editing the file by hand, run sudo systemctl restart spagent.
Need help?
Email hosting@serverplanet.co.uk or call or WhatsApp 0722 155 343, Monday to Friday, 8 AM to 11 PM. We can also install the agent for you (setup service).