Configuration
Buzz reads server configuration when the Python modules are imported. Restart the server after changing an environment variable.
Command-line options take precedence where noted.
Environment Variables
Section titled “Environment Variables”| Variable | Purpose | Default | Requirement |
|---|---|---|---|
BUZZ_PORT |
Port used by the Buzz server. The --port option takes precedence. |
8080 |
Optional |
BUZZ_DATA_DIR |
Directory containing deployed sites and the SQLite database. | Server package directory | Optional |
BUZZ_DOMAIN |
Bare hostname for the dashboard and site subdomains, without a scheme, port, or path. | Not set | Required unless the server runs with –dev. |
GITHUB_CLIENT_ID |
Client ID for the GitHub OAuth app used for dashboard sign-in. | Not set | Required unless the server runs with –dev. |
GITHUB_CLIENT_SECRET |
Client secret for the GitHub OAuth app. | Not set | Required unless the server runs with –dev. |
BUZZ_ANALYTICS_SECRET |
Secret used to hash analytics visitors. Falls back to GITHUB_CLIENT_SECRET, then a process-local random value. |
Not set | Optional |
BUZZ_MAX_ARCHIVE_BYTES |
Maximum compressed deployment archive size in bytes. | 524288000 |
Optional |
BUZZ_MAX_SITE_BYTES |
Maximum extracted size of one deployed site in bytes. | 524288000 |
Optional |
BUZZ_MAX_SITE_FILES |
Maximum number of files and directories in one deployed site. | 10000 |
Optional |
BUZZ_MAX_ARCHIVE_PATH_BYTES |
Maximum UTF-8 byte length of a path in a deployment archive. | 1024 |
Optional |
BUZZ_ALLOW_REGISTRATION |
Whether new GitHub users can sign up. Existing users keep access when disabled. | true |
Optional |
BUZZ_ALLOWED_GITHUB_USERS |
Comma-separated GitHub usernames allowed to sign in. When set, unlisted users are denied on every request and listed users may sign up even when registration is disabled. | Not set | Optional |
BUZZ_TRAEFIK_DYNAMIC_DIR |
Traefik file-provider directory mounted into the Buzz container. Buzz writes the wildcard certificate to buzz-certificate.yaml and custom-domain routers to buzz-routes.yaml there. |
Not set | Optional |
BUZZ_CLOUDFLARE_DNS_API_TOKEN |
Cloudflare API token with Zone:Read and DNS:Edit on the zone of BUZZ_DOMAIN. With BUZZ_TRAEFIK_DYNAMIC_DIR, Buzz obtains and renews the certificate for BUZZ_DOMAIN and *.BUZZ_DOMAIN itself. |
Not set | Optional |
BUZZ_ACME_DIRECTORY_URL |
ACME directory Buzz uses for its wildcard certificate. Point it at the Let’s Encrypt staging directory to rehearse issuance. | https://acme-v02.api.letsencrypt.org/directory |
Optional |
BUZZ_CUSTOM_DOMAINS_ENABLED |
Whether this Buzz server enables the optional custom-domain control plane. Requires BUZZ_TRAEFIK_DYNAMIC_DIR. |
false |
Optional |
BUZZ_TRAEFIK_HTTPS_ENTRYPOINT |
Traefik HTTPS entrypoint expected by custom-domain routers. | https |
Optional |
BUZZ_TRAEFIK_SERVICE |
Provider-qualified Traefik service used by custom-domain routers. | buzz@docker |
Optional |
BUZZ_CUSTOM_DOMAIN_OPERATOR_TOKEN |
Bearer tokens, separated by commas, for the private custom-domain operator endpoint. The endpoint listens only when this is set. | Not set | Optional |
BUZZ_MAX_CUSTOM_DOMAINS_PER_SITE |
Maximum pending and verified custom domains for one site. | 5 |
Optional |
BUZZ_MAX_CUSTOM_DOMAINS_PER_USER |
Maximum pending and verified custom domains owned by one user. | 20 |
Optional |
BUZZ_MAX_CUSTOM_DOMAINS_SERVER_WIDE |
Maximum pending and verified custom domains across this Buzz server. | 1000 |
Optional |
BUZZ_CUSTOM_DOMAIN_INGRESS_IPS |
Comma-separated public ingress IP addresses allowed for direct custom domains. | Not set | Optional |
BUZZ_CUSTOM_DOMAIN_ORIGIN_HOST |
Internal Traefik hostname Buzz probes on port 443 to check the wildcard certificate and custom-domain routing. | coolify-proxy |
Optional |
BUZZ_TRAEFIK_CERT_RESOLVER |
Traefik certificate resolver selected by custom-domain routers. It must issue certificates through HTTP-01. | letsencrypt |
Optional |
BUZZ_CUSTOM_DOMAIN_RECONCILE_SECONDS |
Seconds between custom-domain router reconciliation attempts. | 5 |
Optional |
CLI Environment Variables
Section titled “CLI Environment Variables”The CLI reads BUZZ_SERVER and BUZZ_TOKEN. The root --server and --token options take precedence, followed by environment variables, then saved configuration.
Keep secrets outside source control. GITHUB_CLIENT_SECRET, BUZZ_ANALYTICS_SECRET, BUZZ_CLOUDFLARE_DNS_API_TOKEN, BUZZ_CUSTOM_DOMAIN_OPERATOR_TOKEN, and BUZZ_TOKEN contain sensitive values.