Skip to content
Servestead

Command Reference

This reference summarizes the commands most operators need. Run bin/servestead --help and bin/servestead <command> --help for the complete flag list.

Build

Section titled “Build”
Terminal window
go build -o bin/servestead .

Local Preflight

Section titled “Local Preflight”
Terminal window
bin/servestead doctor

Generate SSH Key

Section titled “Generate SSH Key”
Terminal window
bin/servestead keygen

Provision

Section titled “Provision”
Terminal window
bin/servestead provision \
  --provider hetzner \
  --name aegis-01 \
  --ssh-key my-provider-key
Terminal window
bin/servestead provision \
  --provider digitalocean \
  --name aegis-01 \
  --ssh-key provider-key-id-or-fingerprint

Guided Setup

Section titled “Guided Setup”
Terminal window
bin/servestead setup --ip 203.0.113.10
Terminal window
bin/servestead setup

Direct Stages

Section titled “Direct Stages”
Terminal window
bin/servestead bootstrap \
  --host 203.0.113.10 \
  --admin-public-key "$HOME/.ssh/id_ed25519.pub" \
  --private-key "$HOME/.ssh/id_ed25519"
Terminal window
bin/servestead harden \
  --host 203.0.113.10 \
  --private-key "$HOME/.ssh/id_ed25519"
Terminal window
bin/servestead network \
  --host 203.0.113.10 \
  --private-key "$HOME/.ssh/id_ed25519"
Terminal window
bin/servestead proxy \
  --host 203.0.113.10 \
  --private-key "$HOME/.ssh/id_ed25519" \
  --domain example.com \
  --email admin@example.com \
  --server-secret 'replace-with-a-long-random-secret'

Credentials

Section titled “Credentials”
Terminal window
bin/servestead pangolin-credentials --profile <profile-id>
bin/servestead pangolin-credentials --ip 203.0.113.10

Stack Management

Section titled “Stack Management”
Terminal window
bin/servestead stack add \
  --profile <profile-id> \
  --compose /path/to/docker-compose.yml \
  --publish web:3000:app
Terminal window
bin/servestead stack env set --profile <profile-id> --stack <name> --file /path/to/.env
bin/servestead stack env remove --profile <profile-id> --stack <name>