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.
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
DBNAME
The name of the PostgreSQL database to use with Temporal.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
temporal
POSTGRES_HOST
The hostname of the PostgreSQL server to use with Temporal.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
localhost
POSTGRES_PASSWORD
The password to use when connecting to the PostgreSQL server.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
password
POSTGRES_PORT
The port of the PostgreSQL server to use with Temporal.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
5432
POSTGRES_USER
The username to use when connecting to the PostgreSQL server.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
postgres
SKIP_DB_CREATE
Whether to skip creating the Temporal database. Use this variable if you have an existing Temporal database or want to set it up manually.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Default | null |
SKIP_SCHEMA_SETUP
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.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Default | null |
SQL_TLS_CERT_PATH
The path to the certificate file to use when connecting to the PostgreSQL server.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
SQL_TLS_DISABLE_HOST_VERIFICATION
Whether to disable host verification when connecting to the PostgreSQL server.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Default | null |
SQL_TLS_ENABLED
Whether to use TLS when connecting to the PostgreSQL server.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Default | null |
TEMPORAL_VISIBILITY_STORE_PASSWORD
The password to use when connecting to the PostgreSQL server for Temporal visibility. Defaults to the value of POSTGRES_PASSWORD.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
password
VISIBILITY_DBNAME
The name of the PostgreSQL database to use with Temporal visibility. Defaults to the value of POSTGRES_USER.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
temporal_visibility
VISIBILITY_DBUSER
The username to use when connecting to the PostgreSQL server for Temporal visibility.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Default | null |
Examples
postgres