Skip to main content

PostgreSQL Database Configuration

Environment variables for configuring PostgreSQL connection and migrations

Basic config​

NameDescriptionRequiredType
POSTGRES_HOST
Hostname or IP address of the PostgreSQL server
true
string
POSTGRES_PORT
Port number on which PostgreSQL is listening
true
number
POSTGRES_DB
Database name to connect to
true
string
POSTGRES_USER
Username for PostgreSQL authentication
true
string

Auth config​

Variables to configure according the authentication type: either username & password or client certificates.

NameDescriptionRequiredType
POSTGRES_PASSWORD
Password for PostgreSQL authentication
Required if:
POSTGRES_SSL = "false"
string
POSTGRES_SSL
Flag if connection to PostgreSQL is by SSL.
⚠️ It will be implemented in the future, for now needs to define the 'DEPLOY_ENV' variable
false
boolean
Default:false
DB_PEM_PATH
File system path to the CA certificate PEM file for SSL connection to PostgreSQL.
Example: /path/to/ca.pem
Required if:
POSTGRES_SSL = "true"
string
DB_CERT_PATH
File system path to the client certificate PEM file for SSL connection to PostgreSQL.
Example: /path/to/cert.pem
Required if:
POSTGRES_SSL = "true"
string
DB_KEY_PATH
File system path to the private key PEM file for SSL connection to PostgreSQL.
Example: /path/to/key.pem
Required if:
POSTGRES_SSL = "true"
string

Miscellaneous​

NameDescriptionRequiredType
MIGRATION_RUN
Flag to determine if database migrations should be run
false
boolean
Default:true