Configuration Reference
Go-Upkeep is configured entirely via environment variables. Pass them through your Docker Compose file or directly to the container.
General
| Variable | Default | Description |
|---|
| UPKEEP_PORT | 23234 | The internal SSH server port. |
| UPKEEP_HTTP_PORT | 8080 | The internal Web server port. |
Database
| Variable | Default | Description |
|---|
| UPKEEP_DB_TYPE | sqlite | Database engine: "sqlite" or "postgres". |
| UPKEEP_DB_DSN | -- | File path for SQLite, or postgres://user:pass@host:5432/db URL. |
Clustering & Security
| Variable | Default | Description |
|---|
| UPKEEP_CLUSTER_MODE | leader | "leader" (default) or "follower". |
| UPKEEP_PEER_URL | -- | URL of the Leader. Required for followers. Example: http://10.0.0.5:8080 |
| UPKEEP_CLUSTER_SECRET | -- | Shared secret key. Required for Clustering and API Backups. |
Web Features
| Variable | Default | Description |
|---|
| UPKEEP_STATUS_ENABLED | false | Set to "true" to enable /status. |
| UPKEEP_STATUS_TITLE | -- | Custom H1 title for the status page. |