Skip to main content

Storage database environment variables

Reference documentation of environment variables for the postgres service and database.

Storage database environment variables available for use with self-hosted Retool deployments.

Only configure environment variables when needed. You can configure many environment variables from your organization's Settings rather than directly editing your deployment's configuration file.

Environment variables take effect only once the change is applied to your deployment, and where you set them depends on how Retool was deployed.

  • Terraform blueprints. Set the variable in retool_helm_extra_values in main.tf, then run terraform apply. Editing Helm values directly on a blueprint-managed instance is overwritten by the next apply.
  • Helm. Set the variable in your values.yaml, then run helm upgrade. That command restarts the affected pods as part of applying the new values, so restarting pods without re-running it doesn't pick up the change.
  • Docker Compose. Set the variable in docker.env, then run sudo docker compose up -d.

DATABASE_MIGRATIONS_TIMEOUT_SECONDS​

The timeout, in seconds, for database migrations. If the migration takes longer than this time, the migration fails. Consider setting a higher value if you're upgrading to another major version of Self-hosted Retool or the upgrade includes changes from multiple minor versions.

Type number
Format Integer
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Default0
Examples
DATABASE_MIGRATIONS_TIMEOUT_SECONDS=1000

ENCRYPTION_KEY​

The encryption key used to encrypt data stored in the PostgreSQL database (e.g., database credentials, SSH keys, etc). Must contain only ASCII characters (required from version 3.332.4). If your key contains non-ASCII characters, rotate it before upgrading. If you change this key without rotating, you will lose access to all resources created before the change.

Type string
Format Plain Text
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaultnull
Examples
ENCRYPTION_KEY=key

POSTGRES_CUSTOM_SSL_CA_FILE_NAME​

The custom SSL CA file name for the PostgreSQL connection. This is required when configuring Google Cloud SQL as the database to use instead of Retool's PostgreSQL database.

Type string
Format Plain Text
ConfigurabilityUpdate the deployment's configuration file.
Required Required
Defaultnull
Examples
POSTGRES_CUSTOM_SSL_CA_FILE_NAME=ca.pem

POSTGRES_CUSTOM_SSL_CERT_PATH​

The custom SSL certificate path for the PostgreSQL connection. This is required when configuring Google Cloud SQL as the database to use instead of Retool's PostgreSQL database.

Type string
Format File Path
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaultnull
Examples
POSTGRES_CUSTOM_SSL_CERT_PATH=/path/to/cert

POSTGRES_CUSTOM_SSL_KEY_FILE_NAME​

The custom SSL key file name for the PostgreSQL connection. This is required when configuring Google Cloud SQL as the database to use instead of Retool's PostgreSQL database.

Type string
Format File Name
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaultnull
Examples
POSTGRES_CUSTOM_SSL_KEY_FILE_NAME=client-key.pem

POSTGRES_SSL_ENABLED​

Whether to enable SSL for the PostgreSQL connection.

Type boolean
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaultfalse
Examples
POSTGRES_SSL_ENABLED=true

POSTGRES_SSL_REJECT_UNAUTHORIZED​

Whether to reject unauthorized SSL certificates for the PostgreSQL connection if POSTGRES_SSL_ENABLED is true.

Type boolean
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaulttrue
Examples
POSTGRES_SSL_REJECT_UNAUTHORIZED=true

USE_GCM_ENCRYPTION​

Whether to use AES-192-GCM authenticated encryption method instead of AES-192-CBC. If set to true, you must also set ENCRYPTION_KEY.

Type boolean
ConfigurabilityUpdate the deployment's configuration file.
Required Optional
Defaultfalse
Examples
USE_GCM_ENCRYPTION=true