Queries environment variables

Reference documentation for query-related environment variables.

Queries environment variables available for use with Self-hosted Retool deployments.

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.

CLIENT_MAX_BODY_SIZE

string

On the https-portal container, specify the maximum request body size, in bytes, megabytes (M), or kilobytes (K). Any upload that exceeds this limit results in a 413 HTTP error. Set to 0 to allow bodies of any size.

Example

CLIENT_MAX_BODY_SIZE=40M

DBCONNECTOR_NUM_WORKERS

number

The number of worker threads for the db-connector container. The default value is Math.min(Math.max(1, numCPUs), 3), where numCPUs is the number of logical CPU cores on the machine determined by Node.js.

Example

DBCONNECTOR_NUM_WORKERS=4

DBCONNECTOR_POSTGRES_POOL_MAX_SIZE

number

The PostgreSQL connection pool maximum size.

Default value is 10.

Example

DBCONNECTOR_POSTGRES_POOL_MAX_SIZE=20

DBCONNECTOR_QUERY_TIMEOUT_MS

number

The duration, in milliseconds, for queries to run before timing out. If your Retool deployment is behind a load balancer, increase the load balancer's timeout by a proportionate amount.

Default value is 120000.

Example

DBCONNECTOR_QUERY_TIMEOUT_MS=120000

ENABLE_CUSTOM_PLATFORM_LEVEL_AUTH_STEPS

boolean

Whether to allow configuration of custom authentication steps for users to perform whenever they log into Retool.

Default value is false.

Example

ENABLE_CUSTOM_PLATFORM_LEVEL_AUTH_STEPS=true

HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS

boolean

Whether to prevent all query headers and cookies from being added to audit log entries.

Default value is false.

Example

HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS=true

KEEPALIVE_TIMEOUT

number

The keep alive timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Example

KEEPALIVE_TIMEOUT=1000

PROXY_CONNECT_TIMEOUT

number

The proxy connect timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Example

PROXY_CONNECT_TIMEOUT=1000

PROXY_READ_TIMEOUT

number

The proxy read timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Example

PROXY_READ_TIMEOUT=1000

PROXY_SEND_TIMEOUT

number

The proxy send timeout for queries, in seconds. Queries that exceed this limit results in a 514 HTTP error.

Example

PROXY_SEND_TIMEOUT=1000