Skip to content

Docs index

These markdown files are the source for the SimpleDeploy docs site, rendered with Astro Starlight.

Read the full site at https://vazra.github.io/simpledeploy.

  • concepts/ what SimpleDeploy is and how it works
  • install/ install on Ubuntu, generic Linux, Docker, macOS CLI, or from source
  • guides/ task-based guides (TLS, backups, alerts, registries, scaling, remote management, …)
  • reference/ configuration, compose labels, CLI, REST API, WebSocket, env vars, ports
  • operations/ production checklist, security hardening, security audit, capacity sizing, DR, troubleshooting
  • architecture/ deep dives into reconciler, proxy, deployer, alerts, metrics, logbuf, auth, store
  • contributing/ setup, build/test, conventions, e2e, writing strategies/targets/Caddy modules, releasing
  • integrations/ GitHub Actions, Terraform, Ansible
  • faq.md