Skip to main content

Temporal environment variables for local clusters

Temporal environment variable reference for self-hosted organizations using a local cluster.

Self-hosted organizations can configure the following Temporal environment variables if they want to use a local cluster. These environment variables are relevant only if all the following are true for your organization:

  • Does not use Kubernetes for self-hosted deployments.
  • Did not use Retool's Helm charts when deploying a self-hosted instance.
  • Uses Retool's Temporal image.
  • Will use a PostgreSQL database as the backing store for Temporal.

Temporal environment variables are only used to configure a local Temporal cluster. These variables are managed by Temporal and function separately from Retool's environment variables.

DBNAME

string

The name of the PostgreSQL database to use with Temporal.

Default value is temporal.

Example
DBNAME=temporal

POSTGRES_HOST

string

The hostname of the PostgreSQL server to use with Temporal.

Example
POSTGRES_HOST=localhost

POSTGRES_PASSWORD

string

The password to use when connecting to the PostgreSQL server.

Example
POSTGRES_PASSWORD=password

POSTGRES_PORT

number

The port of the PostgreSQL server to use with Temporal.

Default value is 5432.

Example
POSTGRES_PORT=5432

POSTGRES_USER

string

The username to use when connecting to the PostgreSQL server.

Example
POSTGRES_USER=postgres

SKIP_DB_CREATE

boolean

Whether to skip creating the Temporal database. Use this variable if you have an existing Temporal database or want to set it up manually.

Example
SKIP_DB_CREATE=false

SKIP_SCHEMA_SETUP

boolean

Whether to skip setting up the Temporal database schema. Use this variable if you have an existing Temporal database or want to set it up manually.

Example
SKIP_SCHEMA_SETUP=false

SQL_TLS_CERT_PATH

string

The path to the certificate file to use when connecting to the PostgreSQL server.

Example
SQL_TLS_CERT_PATH=

SQL_TLS_DISABLE_HOST_VERIFICATION

boolean

Whether to disable host verification when connecting to the PostgreSQL server.

Example
SQL_TLS_DISABLE_HOST_VERIFICATION=false

SQL_TLS_ENABLED

boolean

Whether to use TLS when connecting to the PostgreSQL server.

Example
SQL_TLS_ENABLED=false

TEMPORAL_VISIBILITY_STORE_PASSWORD

string

The password to use when connecting to the PostgreSQL server for Temporal visibility. Defaults to the value of POSTGRES_PASSWORD.

Default value is password.

Example
TEMPORAL_VISIBILITY_STORE_PASSWORD=password

VISIBILITY_DBNAME

string

The name of the PostgreSQL database to use with Temporal visibility. Defaults to the value of POSTGRES_USER.

Example
VISIBILITY_DBNAME=temporal_visibility

VISIBILITY_DBUSER

string

The username to use when connecting to the PostgreSQL server for Temporal visibility.

Default value is postgres.

Example
VISIBILITY_DBUSER=postgres