BullMQ Proxy
  • What is BullMQ Proxy
  • Getting started
    • Architecture overview
    • Using Dragonfly
  • HTTP API
    • Authentication
    • Queues
      • Adding jobs
        • Retries
        • Delayed jobs
        • Prioritized
        • Repeatable
        • LIFO
        • Custom Job IDs
      • Getting jobs
      • Queue's actions
      • Reference
    • Workers
      • Endpoints
      • Adding workers
        • Concurrency
        • Rate-Limit
        • Removing finished jobs
        • Stalled jobs
        • Timeouts
      • Removing workers
      • Getting workers
      • Reference
    • Jobs
      • Jobs' actions
        • Update job progress
        • Add job logs
      • Reference
    • Configuration
    • Debugging
Powered by GitBook
On this page
  1. HTTP API

Configuration

Environment variables available for BullMQ Proxy

PreviousReferenceNextDebugging

Last updated 1 year ago

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

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

bull

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

8080

Port where the proxy will listen for requests.

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

localhost

Host where the Redis™ instance is running.

6379

Port used for the Redis™ instance.

Optiona username for the used Redis™ instance.

Password used for the Redis™ instance.

Enable TLS when connecting to the Redis™ instance.

100

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

false

Enable debugging logs.

3

Minimum allowed length for queue names.

100

Maximum allowed length for queue names.

Redis™ key where to store metadata for registered workers.

AUTH_TOKENS
QUEUE_PREFIX
PORT
REDIS_URI
REDIS_HOST
REDIS_PORT
REDIS_USERNAME
REDIS_PASSWORD
REDIS_TLS
QUEUE_CACHE_SIZE
DEBUG
MIN_QUEUE_NAME_LENGTH
MAX_QUEUE_NAME_LENGTH
WORKER_METADATA_KEY
bullmq-proxy:workers