Environment Variables
The server reads environment variables at startup; those server properties
specified in an environment variable are overridden by properties specified on
the command line, but take precedence over properties written in a
configuration file. The exception is PGEDGE_POSTGRES_CONNECTION_STRING,
which does not configure the datastore. The server supports the following
variables:
PGEDGE_POSTGRES_CONNECTION_STRINGPGEDGE_CONNECTION_SECURITY_SSL_CERT_DIRPGEDGE_DB_LOG_LEVELPGEDGE_MEMORY_ENABLEDPGEDGE_AUDIT_RETENTION_DAYS
PGEDGE_POSTGRES_CONNECTION_STRING
The PGEDGE_POSTGRES_CONNECTION_STRING variable provides a fallback
PostgreSQL connection string that the server's database client uses only when
no database user is configured. The variable does not satisfy the datastore
configuration; the server does not start unless the database section of the
configuration file or the
-db-* command-line options supply the datastore
settings, including a user.
In the following example, the variable specifies a remote database:
export PGEDGE_POSTGRES_CONNECTION_STRING=\
"postgres://user:[email protected]:5432/\
ai_workbench?sslmode=require"
The server reads a + in a query parameter value as a literal plus sign, as
libpq does; write a space in a value as %20.
PGEDGE_CONNECTION_SECURITY_SSL_CERT_DIR
The PGEDGE_CONNECTION_SECURITY_SSL_CERT_DIR variable sets the
connection_security.ssl_cert_dir option, the absolute directory that
monitored connections' SSL certificate, key and root certificate files must
live in. A non-empty value overrides the configuration file, and the
-connection-ssl-cert-dir flag overrides the variable. The server reads the
variable at startup only. See
Using the ssl_cert_dir Property
for the rules that the server applies to each path.
In the following example, the variable names the certificate directory:
export PGEDGE_CONNECTION_SECURITY_SSL_CERT_DIR=\
/etc/pgedge/ai-dba-workbench/certs
PGEDGE_DB_LOG_LEVEL
The PGEDGE_DB_LOG_LEVEL variable controls the verbosity of database operation
logging. The server writes database log messages to stderr with a
[DATABASE] prefix.
The following values are supported:
nonedisables all database logging (default).infologs connections, queries, and errors.debuglogs metadata, pool details, and queries.tracelogs full queries, row counts, and timings.
An empty or unrecognized value defaults to none.
In the following example, the variable enables debug logging:
export PGEDGE_DB_LOG_LEVEL=debug
PGEDGE_MEMORY_ENABLED
The PGEDGE_MEMORY_ENABLED variable controls the chat memory feature for Ask
Ellie. The server reads this variable at startup and applies the value as an
override to the memory.enabled configuration option.
The following values are supported:
trueenables chat memory (default).falsedisables chat memory.
In the following example, the variable disables chat memory:
export PGEDGE_MEMORY_ENABLED=false
PGEDGE_AUDIT_RETENTION_DAYS
The PGEDGE_AUDIT_RETENTION_DAYS variable controls how many days of RBAC audit
events the server keeps. The server reads this variable at startup and applies
the value as an override to the http.auth.audit_retention_days configuration
option. A value of 0 keeps audit events forever.
In the following example, the variable keeps a year of audit events:
export PGEDGE_AUDIT_RETENTION_DAYS=365