Docs

Getting started

From first login to a live service with a domain.

1. Owner setup

Open the Setup URL. A short wizard creates the owner account and organization. Public registration stays closed afterward — invite teammates from Settings → Organization.

2. Deploy something trivial

  • Docker image: New application → source Docker image → traefik/whoami:v1.10.1 → Domain → Deploy
  • Template: Templates → pick a small app (e.g. Uptime Kuma) → deploy sheet → Domain

3. Wire Git

Settings → Git Providers → connect GitHub / GitLab / Bitbucket / Gitea. On the app: choose the repo, enable auto-deploy, optionally Preview Deployments for PRs.

4. Automate

  • API key under Settings → Profile → use @nixploy/cli or curl
  • Swagger at /swagger on your panel
  • GitOps export/import via nixploy.yaml
  • MCP at POST /api/mcp for AI agents

Also see the repository guides under docs/ · REST API reference

Docs menu