Documentation Index
Fetch the complete documentation index at: https://mintlify.com/calagopus/panel/llms.txt
Use this file to discover all available pages before exploring further.
The panel binary ships with a built-in CLI for administrative operations that don’t require the web UI. Use it to create resources, manage extensions, run diagnostics, and migrate from other panels. Most commands require the panel’s environment to be present (the same config used by the running service).
All examples below assume a Docker Compose deployment. Run them from the directory containing your compose.yml:
docker compose exec web panel <command> [flags]
Interactive prompts appear automatically when required arguments are omitted and the terminal supports them. When running in a non-interactive context (scripts, CI), pass all required flags explicitly.
Top-level commands
version
Prints the current panel version, build target, and copyright notice.
docker compose exec web panel version
service-install
Installs a system service unit for the panel binary. Linux only. Supports systemd and OpenRC.
docker compose exec web panel service-install [flags]
| Flag | Default | Description |
|---|
-o, --override | false | Overwrite an existing service file. |
-i, --init | auto | Init system to target: systemd, openrc, or auto. |
auto is used, the command detects the init system by checking for /run/systemd/system (systemd) or /run/openrc / /sbin/openrc-run (OpenRC).
diagnostics
Collects system information and recent log lines, then optionally uploads the report to pastes.dev for sharing with support.
docker compose exec web panel diagnostics [flags]
| Flag | Default | Description |
|---|
-l, --log-lines | 500 | Number of log lines to include in the report. |
users commands
Manage user accounts from the command line.
users create
Creates a new user. All fields can be provided as flags or entered interactively.
docker compose exec web panel users create [flags]
| Flag | Description |
|---|
--username | Username for the new account. |
--email | Email address. |
--name-first | First name. |
--name-last | Last name. |
--password | Password. Omit to be prompted securely. |
--admin | true or false. Defaults to false when non-interactive. |
--json | Print the created user as JSON. |
# Interactive
docker compose exec web panel users create
# Non-interactive
docker compose exec web panel users create \
--username admin \
--email admin@example.com \
--name-first Alice \
--name-last Smith \
--password 'hunter2' \
--admin true
users reset-password
Resets the password for an existing user. The user can be identified by username, email, or UUID.
docker compose exec web panel users reset-password [flags]
| Flag | Description |
|---|
--user | Username, email address, or UUID of the target account. |
--password | New password. Omit to be prompted securely. |
docker compose exec web panel users reset-password --user alice@example.com
users disable-2fa
Removes TOTP (two-factor authentication) from a user’s account, including all recovery codes. Use this to unlock an account when a user has lost their authenticator device.
docker compose exec web panel users disable-2fa [flags]
| Flag | Description |
|---|
--user | Username, email address, or UUID of the target account. |
docker compose exec web panel users disable-2fa --user alice@example.com
nodes commands
Manage daemon nodes.
nodes create
Creates a new node. Use this when adding a Wings server outside of the web UI, for example in automated provisioning scripts.
docker compose exec web panel nodes create [flags]
| Flag | Required | Description |
|---|
--location-uuid | Yes | UUID of the location to assign this node to. |
--name | Yes | Display name for the node. |
--url | Yes | URL of the Wings daemon (for example, https://node1.example.com:8080). |
--memory | Yes | Total memory on the node, in bytes. |
--disk | Yes | Total disk space on the node, in bytes. |
--sftp-port | No | SFTP port (default: 2022). |
--sftp-host | No | SFTP hostname if different from the daemon URL host. |
--public-url | No | Public URL used for user-facing links. |
--description | No | Optional description. |
--backup-configuration-uuid | No | UUID of a backup configuration to associate with this node. |
--deployment-enabled | No | true or false (default: true). |
--maintenance-enabled | No | true or false (default: false). |
--json | No | Print the created node as JSON. |
nodes reset-token
Generates a new authentication token for a node. Use this if a node’s token is compromised or after a Wings reinstall.
docker compose exec web panel nodes reset-token [flags]
| Flag | Description |
|---|
--node | Name or UUID of the node. |
--json | Print the new token ID and token as JSON. |
docker compose exec web panel nodes reset-token --node "us-east-1" --json
nests commands
Manage nests — the top-level containers that group eggs.
nests create
Creates a new, empty nest.
docker compose exec web panel nests create [flags]
| Flag | Description |
|---|
--author | Author identifier (typically an email address, for example admin@example.com). |
--name | Name for the nest. |
--json | Print the created nest as JSON. |
nests mass-import
Imports all egg files from a directory into an existing nest. Supports both JSON and YAML/YML egg files.
docker compose exec web panel nests mass-import [flags] <path>
| Flag | Default | Description |
|---|
--nest | — | Name or UUID of the target nest. |
-r, --recursive | false | Scan the path recursively for egg files. |
-u, --update | true | Update existing eggs when a conflict is detected. |
-i, --ignore-errors | false | Continue past errors on individual eggs instead of aborting. |
# Import eggs from a flat directory
docker compose exec web panel nests mass-import --nest "Game Servers" /path/to/eggs
# Import recursively and skip erroring eggs
docker compose exec web panel nests mass-import \
--nest "Game Servers" \
--recursive \
--ignore-errors \
/path/to/eggs
If no eggs are imported, try adding --recursive or verify that the files have .json, .yml, or .yaml extensions.
backups commands
backups s3 import
Reconciles S3 storage with the panel database — creates database records for backup files that exist in S3 but are not tracked.
docker compose exec web panel backups s3 import
import commands
Migrate data from another panel into Calagopus.
import pterodactyl
Imports users, SSH keys, locations, nodes, nests, eggs, egg variables, database hosts, servers, server databases, server variables, allocations, subusers, schedules, and backups from a Pterodactyl installation.
docker compose exec web panel import pterodactyl [flags]
| Flag | Default | Description |
|---|
-e, --environment | /var/www/pterodactyl/.env | Path to the Pterodactyl .env file. |
docker compose exec web panel import pterodactyl \
--environment /var/www/pterodactyl/.env
.env file, connects to the source MySQL database, and inserts records into the Calagopus PostgreSQL database. Existing records (matched by UUID) are skipped without error.
Set up and configure the Calagopus panel fully before running the import. The import reads from a live Pterodactyl database, so the source panel can remain running during migration.
import pelican
Imports from a Pelican panel. Accepts the same --environment flag as the Pterodactyl importer.
docker compose exec web panel import pelican \
--environment /var/www/pelican/.env
extensions commands
Manage Calagopus extensions — packaged frontend and backend modules distributed as .c7s.zip archives.
Extension commands that modify the extension list (add, remove, update, clear) must be run from the panel root directory, where the .sqlx directory is present.
extensions list
Lists all installed extensions and their apply status.
docker compose exec web panel extensions list [--json]
extensions inspect
Displays metadata for a .c7s.zip extension archive without installing it.
docker compose exec web panel extensions inspect <file>
extensions add
Installs an extension from a .c7s.zip file. After adding, run extensions apply to build and activate the extension.
docker compose exec web panel extensions add [flags] <file>
| Flag | Default | Description |
|---|
--skip-version-check | false | Skip the panel version compatibility check. Not recommended. |
docker compose exec web panel extensions add ./my-extension.c7s.zip
docker compose exec web panel extensions apply
extensions update
Updates an already-installed extension from a new .c7s.zip file.
docker compose exec web panel extensions update <identifier> <file>
extensions remove
Removes an installed extension by its package identifier.
docker compose exec web panel extensions remove <identifier>
extensions clear
Removes all installed extensions.
docker compose exec web panel extensions clear
extensions apply
Builds the panel with all currently installed extensions and replaces the running binary. This is required after adding, updating, or removing extensions.
docker compose exec web panel extensions apply
node, pnpm, and the Rust toolchain to be present in the build environment.
extensions init
Scaffolds a new extension using a template.
docker compose exec web panel extensions init
extensions export
Exports an installed extension to a .c7s.zip archive.
docker compose exec web panel extensions export <identifier>
extensions resync
Resyncs the internal extension list used during the build step. Run this if the list becomes out of sync.
docker compose exec web panel extensions resync
database-migrator commands
Low-level commands for managing the panel’s database migration state. These are most useful when running migrations manually or when developing extensions that add their own migrations.
database-migrator status
Shows which migrations have been applied and which are pending.
docker compose exec web panel database-migrator status
database-migrator migrate
Applies all pending database migrations.
docker compose exec web panel database-migrator migrate
When DATABASE_MIGRATE=true is set in compose.yml, this runs automatically on every container start. Use this command only when you need to run migrations manually, for example after adding an extension’s migrations.
database-migrator create
Creates a new blank migration file for an extension. Intended for extension developers.
docker compose exec web panel database-migrator create
database-migrator version
Prints the database migrator version.
docker compose exec web panel database-migrator version