Skip to main content
Complete the steps in order. Setup validates the host before it writes runtime configuration or starts services.

Obtain the source

Verify the Docker toolchain

P-BitM requires Docker Engine 23.0 or newer plus the Buildx and Compose plugins. All three commands must succeed:
The standalone docker-compose command is not supported. See the requirements for installation guidance.Run these checks and P-BitM as the current user when possible. On Linux, grant that trusted user Docker access as described in the requirements when docker info is denied. No particular UID/GID is required. sudo and direct root launches are supported, but the application containers still run as a matched non-root identity.

Install the CLI dependencies

Review the configuration

Open config.yaml and confirm at least:
  • app.environment;
  • app.dashboard_url;
  • storage and certificate paths;
  • enabled Docker images;
  • DNS challenge provider and credential variable names.
Do not place DNS credentials or application secrets in config.yaml.

Provision runtime files

Setup checks Docker Engine, Buildx, and the Compose plugin; generates server/.env; provisions DNS credential files for production; creates storage directories private to the selected runtime identity; and generates local TLS certificates when they are missing. On Linux it also selects the runtime UID/GID and records it in server/.env.DNS credentials are stored below the ignored server/.secrets/dns/ directory with restrictive permissions. To replace them later:

Run diagnostics

Resolve every failure before starting the stack. Warnings are non-blocking during normal operation but block doctor --strict.

Continue to quick start

Start the control plane, verify its health, and prepare an authorized campaign.
Last modified on August 28, 2026