Repository navigation
Server
github-actions[bot] edited this page Nov 22, 2026
·
1 revision
What a server needs before Spotcraft can be deployed on it. Spotcraft deploys nothing itself: each release ships a bundle, and something you run puts it on your server. On Hetzner Cloud, kodentuzo/hetzner does all of this for you, and is the recommended way.
- Debian 13 (or 12) or Ubuntu 24.04, 8 GB of memory or more, ARM or x86.
- Docker with the Compose plugin, from Docker's own apt repository.
- A
deployuser that logs in with an SSH key only, in thedockergroup. Root and password logins are off. -
/opt/spotcraft, owned bydeploy, withapps/andsites/inside it owned by uid and gid1000(the agent's user in the image). - Open ports: 22 for SSH, and 80 and 443 (TCP, plus UDP 443 for HTTP/3) unless a Cloudflare Tunnel delivers the traffic. Everything else stays closed: only Caddy is published.
- Optional but recommended: unattended security upgrades, and Docker's
json-filelogs capped at 3 × 10 MB.
kodentuzo/hetzner's hetzner/cloud-init.yaml sets all of this up at first boot. On another
provider, use it as the server's user data, with its placeholder filled in.
Each release has spotcraft-X.Y.Z.tar.gz,
with SHA256SUMS and a GitHub attestation of its build:
| Path | What |
|---|---|
server/ |
compose.yaml, Caddyfile, pg_hba.conf, scrape.yaml, blackbox.yml
|
remote-deploy.sh |
runs on the server: writes .env, pulls and starts everything, checks it |
To deploy a release:
- Check it:
sha256sum --check SHA256SUMS, andgh attestation verify spotcraft-X.Y.Z.tar.gz --repo kodentuzo/spotcraft. - Copy
server/*into/opt/spotcraftasdeploy. - Run
remote-deploy.shthere over SSH, with its settings asexportlines on its standard input, never on the command line. The script's header lists them;SPOTCRAFT_TAGis the same version as the bundle.
kodentuzo/hetzner's Deploy workflow does exactly this.
Published from docs/. Edit the files there; changes here are overwritten.