Skip to content

NebulaCtrl documentation

Install it, connect servers, deploy, and look up every CLI command and API endpoint. These are the latest docs. The same pages ship inside each release of the control plane, so an installed version always has the pages that match it.

For AI agents

Point a coding agent at the index below. Every page also reads as plain markdown: add .md to its address, or use llms-full.txt for everything in one file. The REST API is described by the OpenAPI document.

https://nebulactrl.com/llms.txt

Getting started

What NebulaCtrl is, the ideas it is built on, and your first deploy.

Installing

Put the control plane on a machine, keep it updated, remove it cleanly.

Applications

Git and image sources, builds, variables, domains, previews, scaling and tasks.

Databases and backups

Managed databases, scheduled backups and restores.

Templates

One click catalogue of self hosted apps.

Servers

Connect hosts, how the agent and proxy work, hardening and clean up.

Observability

Logs, metrics, analytics and notifications.

Teams and security

Roles, sign in methods, SSO, secret managers and the threat model.

Platform services

The services NebulaCtrl can run for itself.

Reference

Every CLI command and API endpoint.

Troubleshooting

When something does not work, and what is not supported.

Internals

Architecture decisions and why they were made.