Redis environment variables
Reference documentation for Redis-related environment variables.
Redis environment variables available for use with self-hosted Retool deployments.
Configuring Redis also ensures security features such as SAML response replay protection are enforced consistently when your deployment runs more than one worker process. See Scale your deployment for details.
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_valuesinmain.tf, then runterraform 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 runhelm 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 runsudo docker compose up -d.
REDIS_DB
The database number for read and write operations, between 0 and 15.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 0 |
Examples
REDIS_DB=0
REDIS_HOST
The hostname of the Redis reader endpoint that connects the Redis instance as a caching layer.
| Type | string |
| Format | Hostname |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
REDIS_HOST=redis-retool
REDIS_PASSWORD
The password for the Redis instance.
| Type | string |
| Format | Password |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
REDIS_PASSWORD=password
REDIS_PORT
The port number of the Redis reader endpoint that connects the Redis instance as a caching layer.
| Type | number |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | 6379 |
Examples
REDIS_PORT=6379
REDIS_TLS
Whether to use TLS for the Redis connection.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
REDIS_TLS=true