Configuration

Environment variables available for BullMQ Proxy

The proxy can be configured using env variables that must be set up at the time the service starts in order to have any affect. In the following table we list the available variables and their default values if any.

Variable
Default
Description
AUTH_TOKENS

Comma separated list of valid tokens that can be used to authenticate in the proxy.

QUEUE_PREFIX

bull

Prefix used for all Redis keys used by the queues managed by the proxy.

PORT

8080

Port where the proxy will listen for requests.

REDIS_URI

Redis URI string. Either this standalone string or separate Redis™ variables can be used.

REDIS_HOST

localhost

Host where the Redis™ instance is running.

REDIS_PORT

6379

Port used for the Redis™ instance.

REDIS_USERNAME

Optiona username for the used Redis™ instance.

REDIS_PASSWORD

Password used for the Redis™ instance.

REDIS_TLS

Enable TLS when connecting to the Redis™ instance.

QUEUE_CACHE_SIZE

100

Maximum number of BullMQ queue instances to keep in the cache.

DEBUG

false

Enable debugging logs.

MIN_QUEUE_NAME_LENGTH

3

Minimum allowed length for queue names.

MAX_QUEUE_NAME_LENGTH

100

Maximum allowed length for queue names.

WORKER_METADATA_KEY
bullmq-proxy:workers

Redis™ key where to store metadata for registered workers.

Last updated