Skip to main content
Version: Dev

Configuration variables

Every value pgConsole accepts, with defaults and bounds. The contract is validated totally before the listener opens; an invalid value fails startup naming the variable and the constraint, never the value. CLUSTER_NAME and NAMESPACE are required DNS-1123 labels; everything else defaults.

VariableDefaultMeaning
CLUSTER_NAMErequiredThe one target CloudNativePG Cluster.
NAMESPACErequiredIts namespace, normally via the downward API.
LISTEN_ADDR:3000Plain HTTP listen address (TLS is the proxy's job).
TRUSTED_USER_HEADERX-Forwarded-UserProxy identity header — display and audit only; empty disables identity and denies every level-gated route.
TRUSTED_LEVEL_HEADERX-PgToolBox-LevelProxy level header carrying view, poweruser, or dba; empty leaves only the read-only baseline.
ALLOW_OPERATIONSfalseEnables the enumerated day-2 operation routes. Strict boolean.
ALLOW_ACCESS_REVIEWfalseEnables the dba access-request review panel. Strict boolean; needs its own Role.
ALLOW_LOGStrueMaster switch for the bounded log tail; when on, the tail still requires the poweruser level.
LOG_TAIL_LINES200Lines per log request, 1–2000.
LOG_TAIL_MAX_BYTES1048576Bytes per log request, 4 KiB–8 MiB.
EVENTS_MAX_AGE1hEvent age window, 1m–24h.
API_REQUEST_TIMEOUT10sPer-request Kubernetes API bound, 1s–1m.
OBJECTSTOREVIEWER_URLemptyObjectStoreViewer link-out; empty hides it.
PGADMIN_URLemptypgAdmin link-out; empty hides it.
MONITORING_URLemptyMonitoring link-out; empty hides it.
ALLOW_INSECURE_LINKSfalsePermits http:// link-outs (lab use only).
REPOSITORY_EVIDENCE_URLemptyEvidence sidecar socket — unix:// URI or absolute path; loopback and TCP refuse to start.
REPOSITORY_EVIDENCE_TOKEN_FILEemptyAbsolute path to the operator-mounted pod-local bearer token.
REPOSITORY_EXPECTED_FINGERPRINTemptyExpected sha256: destination fingerprint responses must carry.
REPOSITORY_BARMAN_SERVERemptyExact Barman server name of the operator-supplied identity mapping.

Notes

  • Strict booleans accept only the literals "true" and "false"; any other value fails startup.
  • Link-outs must be https and carry no user information, unless ALLOW_INSECURE_LINKS=true permits http.
  • The four REPOSITORY_* variables validate all-or-nothing: set any and all are required; set none and the evidence consumer is disabled entirely.
  • Setting TRUSTED_USER_HEADER or TRUSTED_LEVEL_HEADER to an explicit empty string is a valid, fail-safe configuration — it removes a capability rather than loosening one.