Operations

Command line

Portiger is one binary with a small command set. The command line is for putting the product on the machine and taking it off again; everything else - stacks, domains, jobs, users, backups - is done in the panel.

install

portiger install <licence key>

Run as root, non-interactive. Verifies and activates the key, installs Docker, initialises the workload pool with this machine as its node, opens the ports that need opening, puts the mail packages on disk masked, installs the systemd service under its own unprivileged user, and prints the panel address. This is what curl -fsSL get.portiger.com | sh -s -- <licence key> ends up running. See Install.

On a machine where setup has already finished, running it again does not start over: it prints where the panel is running.

update

portiger update

Fetches the new package from the signed apt repository. The database is backed up automatically before anything is replaced, and migrations run when the new version starts.

uninstall

portiger uninstall

Removes the service and the packages, asking what to do with the data directory. See Backup, update, uninstall.

serve

What the systemd unit runs. It is not something you type by hand: it is the panel process itself, and it is also what sets publishing up the first time that is needed. Its state is read with ordinary systemd tools.

Resetting the owner password. An installation with no working mail path has no self-service password reset, so the owner's password can be reset from the command line on the machine itself. The person is then asked to set a new one at their next sign-in.

What is deliberately not here

There is no command that creates a stack, publishes a domain, adds a user or restores a backup. Those are panel operations, and each of them shows what it is about to do before doing it - which a one-line command cannot.

dev