Getting started

1. Owner setup

Open the Setup URL the installer printed. It carries a one-time setup token (?token=…) so a scanner cannot win the race for the first admin account on a fresh host. A short wizard creates the owner account and organization; public registration stays closed afterward.

Teammates join through a shareable invite link from Settings → Organization — no SMTP required. The link discloses only a masked email; the invitee types the address to prove they are the right recipient.

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 — pick the narrowest scope (read, deploy, write or admin)
• Swagger at /swagger on your panel
• GitOps export/import via nixploy.yaml
• MCP at POST /api/mcp for AI agents

5. Optional power features

• Deploy Copilot — Settings → Platform → Copilot, with your own LLM key
• Shared variables — Settings → Organization, inherited by every project, environment and service
• Single sign-on — set NIXPLOY_OIDC_ISSUER / CLIENT_ID / CLIENT_SECRET and /login grows a Continue with … button
• Remote servers — Settings → Servers, joined to the same Swarm over SSH
• Watch paths — only deploy a push when a matching file changed