Guide index

NineDeploy documentation

The guides are grouped by what you are doing. The last group holds the project's own records, such as audits, acceptance evidence and roadmaps. Those are kept for transparency; you do not need them to run NineDeploy.

Get started

• Quickstart: install, first sign-in, first deploy, upgrades.
• Support matrix: which service features work on the panel host, on nodes, on Swarm, and for Compose and PM2.
• Troubleshooting: common failures and how to recover.
• Moving from Coolify, Dokploy, CapRover or Heroku: a read-only import plan (ninedeploy import plan), then ninedeploy import apply to create the services and databases, ninedeploy import data to move database contents and service volumes, and ninedeploy import cutover to add the domains once DNS points here.

Guides

Deploying

• Deployments: builds, healthchecks, zero-downtime releases, canaries, autoscaling, scale to zero, previews and approvals.
• Rolling back a release
• Private repositories: sources, deploy keys and commit statuses.
• GitHub App: one-click setup, PR previews and required CI.
• CI on your own runners
• The .ninedeploy manifest

Data

• Databases and backups
• Restore verification and point-in-time recovery
• Panel self-backup

Networking

• Ingress, routing and tunnels
• Remote nodes
• Node operations: readiness, metrics and logs on nodes.

Access and security

• Security and single sign-on: 2FA, passkeys, OIDC, SAML and the panel IP allow-list.
• SSO account linking
• Workspaces and roles
• Secret managers
• Terminals

Observability

• Resource history, metrics export and durable logs
• Uptime monitors and status pages
• AI assistant

Reference

• API, MCP server, CLI and SDK
• Plugins and the microkernel
• Instance GitOps
• Template mirrors
• Interface translations
• Desktop client
• Developing on macOS
• The architecture guide, at ../ARCHITECTURE.md.

Project records

These documents are kept for transparency. They are dated, and parts of them describe work in progress.

• Roadmap and the current plan, plans/COMPETITIVE_ROADMAP_2026-11.md
• Competitor gap roadmap, 2026-10
• Competitive delivery: acceptance evidence
• Node work in progress: request-rate autoscaling and scale to zero and wake
• Swarm runtime acceptance
• Audits: 0.10.2, 0.10.8, security remediation, 2026-09
• Persistent port ingress plan