Skip to main content
The dreadnode platform command group manages the lifecycle of the self-hosted platform.

Commands

start

Starts the platform services.
dreadnode platform start [flags]
--tag
string
Start a specific image tag (e.g., v1.2.3-amd64). If omitted, uses the current version or downloads the latest.
--<key>
value
Set one-off environment overrides (e.g., --proxy-host example.com). See Configuration.

stop / down

Stops the running platform services.
dreadnode platform stop
--remove-volumes
boolean
Also remove Docker volumes. WARNING: This deletes all data.

configure

Manage persistent environment configuration.
dreadnode platform configure [key value...] [flags]
--list, -l
boolean
List current persistent overrides.
--unset, -u
boolean
Remove specified configuration keys.
--tag
string
Apply configuration to a specific version tag.
Examples:
dreadnode platform configure PROXY_HOST platform.example.com
dreadnode platform configure --unset PROXY_HOST

upgrade

Upgrades the platform to the latest version available.
dreadnode platform upgrade
Prompts to download the latest version and optionally merge your existing configuration.

download

Downloads platform files for a specific version without starting it.
dreadnode platform download --tag <string>

logs

View the logs of the running platform services.
dreadnode platform logs [flags]
--tail
integer
default:"100"
Number of lines to show from the end of the logs.

status

Check if the platform services are running.
dreadnode platform status

refresh-registry-auth

Refresh credentials for the private container registries.
dreadnode platform refresh-registry-auth
Use this if you encounter authentication errors when pulling images or if your session has expired.

version

Display the current platform version information.
dreadnode platform version [--verbose]