Documentation — Guides and API Reference

Quick Start

Get running in under five minutes. Install on Ubuntu 22.04 or newer, or Debian 12 or newer, with a single curl command. The automated installer provisions Python, Docker, Nginx, SSL certificates, and systemd services. After installation completes, access the web dashboard through your browser to create an admin account and begin deploying applications immediately. No manual configuration of reverse proxies, process managers, or SSL is required.

Getting Started Guides

The installation guide covers system requirements, the one-line installer, Docker Compose setup, and manual installation options for advanced users. The deployment guide explains production configuration including SSL setup, systemd service management, environment variables, backup strategies, and CLI commands. The local development guide walks through setting up a Windows development environment with WSL2, using Docker Compose dev mode for rapid iteration, and configuring VS Code Dev Containers for a consistent cross-platform development experience.

Architecture and API

The architecture documentation describes the overall system design, HTTP request flow through Nginx and Gunicorn, the template rendering system, automatic port allocation strategy, and a visual component diagram showing how the backend, frontend, and services interconnect. The REST API reference documents every endpoint including authentication, application lifecycle management, domain configuration, SSL provisioning, database operations, Docker container control, file operations, cron scheduling, firewall rules, security scanning, and system monitoring. The multi-environment guide explains how to link WordPress production and development instances using shared databases with separate table prefixes and visual environment badges.

CLI Reference

The command-line interface provides direct control over all panel services without opening a browser. Available commands include start, stop, and status for service management, create-admin for initial account setup, backup-db for creating database snapshots, logs for viewing real-time service output, and update for upgrading to the latest release. All commands accept standard flags for output formatting and verbosity control.