Add a server

Bring another machine into the fleet with one command pasted on that machine. Deplo never connects to it.

Deplo prints a command with a one-time token. Run it as root on the new server: it installs the agent, which connects to Deplo by itself. Deplo never connects to the host, over SSH or otherwise.

What the machine needs

WhatRequirement
SystemA supported distribution on linux/amd64 or linux/arm64, with systemd and root for one command. Docker is installed if missing, except on a migration source, which keeps the Docker it imports from.
Toolscurl and sha256sum, to download the agent and verify it.
Disk30 GB free on / recommended. The installer refuses below 5 GB.
NetworkIt must reach the panel's address, the one in the command. No open port is needed for Deplo.

Nothing checks memory or CPU: what needs them is what you deploy. Size it like the first one, 2 cores and 4 GB at least, unless it only holds backups.

Add one

Instance admins only.

Open the dialog

Settings -> Servers, then Add. The dialog is Add a server.

Name it and set the address

A Display name, then Host or IP: the address your apps on this server are reached at, like 203.0.113.24. Their generated addresses and DNS checks use it; Deplo never connects to it. A private IP like 10.0.0.7 works, but generated addresses then answer only inside that network.

Let teams use it

Team access defaults to All teams. Specific teams with none ticked is refused. You can change it later: see Team access.

Choose what it's for

What this server is for:

  • Everything: runs apps and builds them.
  • Build (beta): builds for other servers. It needs the same CPU architecture as the servers it builds for; mismatched pairs show but are disabled.
  • Backups: holds backup files and runs nothing.

The server list shows the last two as Build only and Backups only. You can change it later under Advanced.

Run the command

Click Add server, then paste the command on the server:

curl -fsSL 'https://deplo.example.com/install-agent.sh' --output /tmp/deplo-agent-install.sh && echo '<token>' | sudo bash /tmp/deplo-agent-install.sh - 'https://deplo.example.com' '<fingerprint>'

It downloads the script before running it, so an address that does not answer fails out loud, and the token goes in on stdin, out of the process list. The server goes from Provisioning to online by itself.

The command is shown once, and its token works once, for about an hour. For a new one, open the server, Advanced -> Install command.

Deplo pins its own certificate in that command

Over https, the command carries the fingerprint of the certificate the panel serves, and the agent refuses to start without it. If Deplo can't read that certificate from its own address, Add server is refused with the reason. Make the panel's address reachable from the panel itself, then try again.

Ports for your apps

Deplo needs no open port: the agent connects to the panel. Only your apps do:

PortWhy
80, 443Traefik serves your apps, and answers the HTTP certificate challenge

A build or backups server runs no apps and needs neither. No installer opens a firewall: if the machine or its provider has one, allow these two.

Check it before you trust it

Check readiness, on the Server agent card of the server's Overview, checks the server once and groups the results as Agent, Docker, Routing, Host capacity, Build methods and Deplo configuration, and counts them as failed, warnings, skipped and passed. Skipped means it could not be evaluated, which is not a pass. Nothing gates on it: it is for you.

Before you add more servers

  • An app and its database must be on the same server to reach each other by name. The deplo network is per host.
  • If containers are already running when the address pools change, the installer skips the Docker restart and tells you to do it in a maintenance window.

Troubleshooting

  • Stuck on Provisioning: the agent never called home. On the server, check systemctl status deplo-agent and journalctl -u deplo-agent -f.
  • Offline: the server is not connected to Deplo, and its card says what to check. See A server is offline.
  • Refusing to run an unverified binary: the download did not match its checksum. Retry; if it persists, something is intercepting the download.
  • The token expired: get a new command from the server's Advanced tab, Install command.
  • Deplo could not read the certificate its own address (https://deplo.example.com) serves: the panel can't reach its own public address, so it has nothing to pin. Check DNS and outbound access from the panel's machine.

More in Servers and agents.

Next steps

Did this page help you?

On this page