Public site · installer and docs

VPS Deployer

Docs

Configuration

Production config lives in /etc/vps-deployer/. Local development uses ./.local/.

VPS_DEPLOYER_SITE_URL (default https://vps-deployer.onebitstack.com) is only used to print documentation and update URLs. It is not the hostname of your VPS dashboard. A dashboard such as https://vps-deployer.centralstackhq.com is configured separately under Settings → Public access. Deploy, rollback, logs, and project management do not require the documentation website.

Useful variables:

VariablePurpose
VPS_DEPLOYER_API_HOSTBind host (127.0.0.1)
VPS_DEPLOYER_API_PORTBind port (5100)
VPS_DEPLOYER_CONFIG_DIRSecrets and GitHub files
VPS_DEPLOYER_DATA_DIRDatabase directory
VPS_DEPLOYER_DATABASE_PATHSQLite file
VPS_DEPLOYER_APPS_ROOTApplication files
VPS_DEPLOYER_RUNTIMEprocess, systemd, or auto
VPS_DEPLOYER_RELEASE_RETENTIONSuccessful releases to keep (default 5)

Secrets in the config directory use mode 600.

This website distributes the installer and documentation. It does not register your VPS, store credentials, or run deployments.

After install, your VPS keeps working if this site is down. Changelog