Skip to content
PesaGuard Docs

Getting started

Production checklist Draft

The base production variant requires these settings before up -d --build. This page mirrors the infrastructure README; the README remains the operational authority.

Required settings

SettingPurpose
POSTGRES_USER / POSTGRES_DB / POSTGRES_PASSWORDProduction database identity and credentials.
DATABASE_URL_DOCKERContainer-reachable connection URL. Write complete URLs; the backend does not expand ${...} references.
PESAGUARD_API_URLPublic base URL used by the status strip and integrations.
JWT_SECRET_KEYToken signing. Treat rotation as a planned operation.
KAFKA_BOOTSTRAP_SERVERS_DOCKERBroker address reachable from containers, not host localhost.
REDIS_URL_DOCKERRedis connection for asynchronous work.
PESAGUARD_BIND_HOST_DOCKERBind address for the API container.
API_SERVER_NAME (AWS/tunnel overlays)The hostname nginx serves — a hostname, not a URL.

Before you go live

  1. Validate the merged configuration with config --quiet — never with plain config, which can print resolved secrets.
  2. Review actual published ports. The AWS overlay's ports: [] does not necessarily remove base-file published ports during Compose merging.
  3. Keep the root .env out of images and out of git. Merge new keys into existing deployments; do not replace the file.
  4. Confirm the reverse proxy passes X-Forwarded- headers and that TLS terminates in front of the API.
  5. Check status probes answer after rollout, and that the audit trail records the rollout operator.
Not a certification

This checklist mirrors repository documentation. It does not certify production suitability of network or security controls; review exposure against your own environment before go-live.