Install

What you need

A Linux machine with systemd and root access, on x86-64 or ARM64. The installer adds Docker when the machine doesn't have it. This machine runs the panel and becomes your first node.

Install the panel

Run this on that machine:

$ curl -fsSL https://getatlas.gg/install.sh | sudo sh

The installer checks the release's signature before it runs anything, then prints the panel's address. Without a domain, the panel answers over plain HTTP on port 8080.

Your settings and the generated secrets live in /opt/atlas/.env. Back that file up.

Set up your network

Open the panel's address in a browser. Setup asks for:

  1. A name for the network, and the owner account.
  2. A licence key, if you have one. Without a key the panel runs on Free.
  3. The first node. Use this machine with one click, or add another one with a join command or over SSH.
  4. A domain, if you want one. Atlas then moves the panel to HTTPS and closes port 8080.

Add a domain later

Point the domain at the machine, then run the installer again with it:

$ curl -fsSL "https://getatlas.gg/install.sh?domain=panel.example.com" | sudo sh

Host other sites

When Atlas runs Caddy for your domain, that Caddy also serves any .caddy file in /opt/atlas/caddy/sites/. Updates leave the folder alone. A site that needs a backend runs it as a container on the atlas_default network and proxies to it by name:

map.caddy
map.example.com {
	reverse_proxy overviewer:80
}

Reload Caddy after you add or change a file:

$ docker compose -f /opt/atlas/compose.yaml exec caddy caddy reload --config /etc/caddy/Caddyfile

If a file has an error, the reload refuses it and the sites keep running on the old config. Fix or remove the file before the next update, because Caddy will not start with it.

Update

$ sudo atlas update

This takes the newest release of your current major version. Add --major to move to a new major version, or --channel stable to switch channel.

Uninstall

$ sudo atlas uninstall

It asks you to type uninstall before it removes anything. Add --keep-data to keep your servers' files, your settings and the database.