Workflows environment variables
Reference documentation for Retool Workflows-related environment variables.
Workflow environment variables available for use with self-hosted Retool deployments. These environment variables specifically can be applied to the api, workflows-worker, and workflows-backend services.
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.
You must restart your instance after setting any variables for them to take effect.
AGENT_EVALS_S3_ACCESS_KEY_ID
The Amazon S3 access key ID for running agent evals.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AGENT_EVALS_S3_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
AGENT_EVALS_S3_BUCKET
The Amazon S3 bucket for running agent evals.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AGENT_EVALS_S3_BUCKET=retool-agent-evals
AGENT_EVALS_S3_REGION
The Amazon S3 region for running agent evals.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AGENT_EVALS_S3_REGION=us-west-2
AGENT_EVALS_S3_SECRET_ACCESS_KEY
The Amazon S3 secret access key for running agent evals.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AGENT_EVALS_S3_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
CODE_EXECUTOR_INGRESS_DOMAIN
The domain for the code-executor service that executes arbitrary user-defined JavaScript and Python code with installed custom libraries. The value depends on your deployment configuration, but must include a protocol (http:// or https://).
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_EXECUTOR_INGRESS_DOMAIN=code-executor.example.com
CUSTOM_API_KEY
An API key to authenticate workflow webhook requests. Add to the request as an x-api-key header to trigger workflows.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CUSTOM_API_KEY=retool_wk_2ed0cfe975474f4091fbe603d975d7b7
TEMPORAL_TASKQUEUE_WORKFLOW
The task queue for the Temporal Cluster. Used by clients connecting to Temporal for all Retool Workflow-related requests (enqueue, query, etc.). This value should match WORKER_TEMPORAL_TASKQUEUE.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | workflows |
Examples
TEMPORAL_TASKQUEUE_WORKFLOW=workflows
WORKER_TEMPORAL_TASKQUEUE
The task queue for the Temporal worker. Used by workers connecting to Temporal for all Retool Workflow-related requests (enqueue, query, etc.). This value should match TEMPORAL_TASKQUEUE_WORKFLOW.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | workflows |
Examples
WORKER_TEMPORAL_TASKQUEUE=workflows
WORKFLOW_BACKEND_HOST
The hostname for all Retool Workflow-related backend requests, such as querying resources, updating workflow status, and storing block results and logs. The value depends on your deployment configuration, but must include a protocol (http:// or https://).
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_BACKEND_HOST=http://workflow-backend
WORKFLOW_BLOCK_STORAGE_LOCATION
The storage location for workflow block results. Defaults to postgres to store results in your PostgreSQL database. Set to s3 to store results in Amazon S3, which reduces database load for high-volume deployments. When set to s3, you must also configure WORKFLOW_S3_BUCKET, WORKFLOW_S3_REGION, WORKFLOW_S3_ACCESS_KEY_ID, and WORKFLOW_S3_SECRET_ACCESS_KEY.
| Type | string | ||||||
| Configurability | Update the deployment's configuration file. | ||||||
| Required | Optional | ||||||
| Allowed Values |
| ||||||
| Default | postgres |
Examples
WORKFLOW_BLOCK_STORAGE_LOCATION=postgres
WORKFLOW_BLOCK_STORAGE_LOCATION=s3
WORKFLOW_S3_ACCESS_KEY_ID
The AWS access key ID with read and write permissions to the S3 bucket specified in WORKFLOW_S3_BUCKET. Required when WORKFLOW_BLOCK_STORAGE_LOCATION is s3.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_S3_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
WORKFLOW_S3_BUCKET
The name of the Amazon S3 bucket used to store workflow block results. Required when WORKFLOW_BLOCK_STORAGE_LOCATION is s3.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_S3_BUCKET=my-retool-workflow-results
WORKFLOW_S3_REGION
The AWS region of the S3 bucket specified in WORKFLOW_S3_BUCKET. Required when WORKFLOW_BLOCK_STORAGE_LOCATION is s3.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_S3_REGION=us-east-1
WORKFLOW_S3_SECRET_ACCESS_KEY
The AWS secret access key for the IAM user specified in WORKFLOW_S3_ACCESS_KEY_ID. Required when WORKFLOW_BLOCK_STORAGE_LOCATION is s3.
| Type | string |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_S3_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
WORKFLOW_TEMPORAL_ACTIVITY_TASK_POLLERS
The number of Temporal activity task pollers that concurrently run.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 2 |
Examples
WORKFLOW_TEMPORAL_ACTIVITY_TASK_POLLERS=2
WORKFLOW_TEMPORAL_CLUSTER_FRONTEND_HOST
The hostname for the Temporal Cluster. If you're using Temporal Cloud, your host may end with .tmprl.cloud. This environment variable does not need to be set if using Retool-managed Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_CLUSTER_FRONTEND_HOST=org.example.tmprl.cloud
WORKFLOW_TEMPORAL_CLUSTER_FRONTEND_PORT
The port for the Temporal Cluster.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 7233 |
Examples
WORKFLOW_TEMPORAL_CLUSTER_FRONTEND_PORT=7233
WORKFLOW_TEMPORAL_CLUSTER_NAMESPACE
The namespace for the Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | workflows |
Examples
WORKFLOW_TEMPORAL_CLUSTER_NAMESPACE=workflows
WORKFLOW_TEMPORAL_CONCURRENT_ACTIVITIES_LIMIT
The maximum number of concurrent activities that can be executed by a single workflow. Refer to the Temporal documentation for more information.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 10 |
Examples
WORKFLOW_TEMPORAL_CONCURRENT_ACTIVITIES_LIMIT=10
WORKFLOW_TEMPORAL_CONCURRENT_TASKS_LIMIT
The maximum number of concurrent tasks that can be executed by a single workflow. Refer to the Temporal documentation for more information.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 10 |
Examples
WORKFLOW_TEMPORAL_CONCURRENT_TASKS_LIMIT=10
WORKFLOW_TEMPORAL_OPENTELEMETRY_COLLECTOR
The OpenTelemetry collector endpoint for Temporal Worker metrics.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_OPENTELEMETRY_COLLECTOR=http://open-telemetry-collector-opentelemetry-collector:4318
WORKFLOW_TEMPORAL_SERVER_NAME_OVERRIDE
The server name override for the Temporal Cluster. This overrides the target name (SNI) used for TLS host name checking. It can be useful if you have reverse proxy in front of Temporal server and you need to override the SNI to direct traffic to the appropriate backend server based on custom routing rules. Connections can be refused if the provided SNI does not match the expected host. Adding this override should be done with care. This does not need to be set if using Retool-managed Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_SERVER_NAME_OVERRIDE=other.domain.tmprl.cld
WORKFLOW_TEMPORAL_SERVER_ROOT_CA_CRT
Base64 encoded PEM certificate for the root CA of the Temporal Cluster. This does not need to be set if using Retool-managed Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_SERVER_ROOT_CA_CRT=UXVpcyBjb21tb2RvIGV4ZXJjaXRhd
WORKFLOW_TEMPORAL_STICKY_CACHE_SIZE
The size of the Temporal sticky queue cache.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 200 |
Examples
WORKFLOW_TEMPORAL_STICKY_CACHE_SIZE=100
WORKFLOW_TEMPORAL_TLS_CRT
Base64 encoded certificate for TLS client certification pair. See Temporal documentation for more details. This does not need to be set if using Retool-managed Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_TLS_CRT=UXVpcyBjb21tb2RvIGV4ZXJjaXRhd
WORKFLOW_TEMPORAL_TLS_ENABLED
Whether to enable TLS for the Temporal Cluster. You can set this to true if you use your own Temporal Cloud. This does not need to be set if using Retool-managed Temporal Cluster.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
WORKFLOW_TEMPORAL_TLS_ENABLED=true
WORKFLOW_TEMPORAL_TLS_KEY
Base64 encoded private key for TLS client certification pair. This does not need to be set if using Retool-managed Temporal Cluster.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
WORKFLOW_TEMPORAL_TLS_KEY=c2VjcmV0X2tleQ==
WORKFLOW_TEMPORAL_WORKER_SHUTDOWN_GRACE_TIME
The timeout, in minutes, to wait for pending workflows to complete before the Temporal worker gracefully shuts down. If the worker does not shut down within this time, it is forcefully terminated.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 15 |
Examples
WORKFLOW_TEMPORAL_WORKER_SHUTDOWN_GRACE_TIME=15
WORKFLOW_TEMPORAL_WORKFLOW_TASK_POLLERS
The number of Temporal workflow task pollers that concurrently run.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 10 |
Examples
WORKFLOW_TEMPORAL_WORKFLOW_TASK_POLLERS=10
WORKFLOW_WORKER_HEALTHCHECK_PORT
The port for the /api/checkHealth health check endpoint for the Temporal worker.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 3005 |
Examples
WORKFLOW_WORKER_HEALTHCHECK_PORT=3005