Interface BunqueueConfig

Global bunqueue configuration (all sections optional). The server validates the file at startup: a value it cannot use stops startup with the key name; a value earlier releases ran with (a numeric string port or timeout, a string read by its truthiness where a boolean is expected, null for "unset", a documented fallback) keeps working, with a warning where it is ignored or reinterpreted; an unknown key is logged as a warning. See docs/features/configuration.md.

interface BunqueueConfig {
    auth?: { requireAuthForMetrics?: boolean; tokens?: string[] };
    backup?: {
        accessKeyId?: string;
        bucket?: string;
        enabled?: boolean;
        endpoint?: string;
        interval?: number;
        prefix?: string;
        region?: string;
        retention?: number;
        secretAccessKey?: string;
        sessionToken?: string;
        virtualHostedStyle?: boolean;
    };
    cloud?: { apiKey?: string; instanceId?: string; url?: string };
    cors?: { origins?: string[] };
    logging?: {
        format?: "text" | "json";
        level?: "info" | "warn" | "error" | "debug";
    };
    server?: {
        host?: string;
        httpPort?: number;
        httpSocketPath?: string;
        tcpPort?: number;
        tcpSocketPath?: string;
        tlsCertFile?: string;
        tlsKeyFile?: string;
    };
    storage?: {
        brokerId?: string;
        completedRetentionMs?: number
        | null;
        dataPath?: string;
        driver?: "memory" | "sqlite" | "postgres";
        idleTransactionTimeoutMs?: number;
        leaseDurationMs?: number;
        lockTimeoutMs?: number;
        maxCompletedJobs?: number;
        maxConcurrentOperations?: number;
        maxQueuedOperations?: number;
        maxRemovedResults?: number;
        maxSnapshotJobs?: number;
        maxSnapshotPayloadBytes?: number;
        namespace?: string;
        pollIntervalMs?: number;
        poolSize?: number;
        removedResultRetentionMs?: number;
        statementTimeoutMs?: number;
        url?: string;
    };
    telemetry?: { maxPrometheusQueues?: number };
    timeouts?: {
        lock?: number;
        shutdown?: number;
        stats?: number;
        worker?: number;
    };
    webhooks?: { maxRetries?: number; retryDelay?: number };
}

Index

Properties

auth? backup? cloud? cors? logging? server? storage? telemetry? timeouts? webhooks?

Properties

`Optional`auth

auth?: { requireAuthForMetrics?: boolean; tokens?: string[] }

`Optional`backup

backup?: {
    accessKeyId?: string;
    bucket?: string;
    enabled?: boolean;
    endpoint?: string;
    interval?: number;
    prefix?: string;
    region?: string;
    retention?: number;
    secretAccessKey?: string;
    sessionToken?: string;
    virtualHostedStyle?: boolean;
}

`Optional`cloud

cloud?: { apiKey?: string; instanceId?: string; url?: string }

`Optional`cors

cors?: { origins?: string[] }

`Optional`logging

logging?: {
format?: "text" | "json";
level?: "info" | "warn" | "error" | "debug";
}

Type Declaration

Optionalformat?: "text" | "json"

Log format (any case is accepted at runtime). Env: LOG_FORMAT.
Optionallevel?: "info" | "warn" | "error" | "debug"

Log level (any case; warning, trace, verbose, fatal and critical are accepted aliases at runtime; another word is a warning). Env: LOG_LEVEL.

`Optional`server

server?: {
    host?: string;
    httpPort?: number;
    httpSocketPath?: string;
    tcpPort?: number;
    tcpSocketPath?: string;
    tlsCertFile?: string;
    tlsKeyFile?: string;
}

Type Declaration

Optionalhost?: string
OptionalhttpPort?: number
OptionalhttpSocketPath?: string
OptionaltcpPort?: number
OptionaltcpSocketPath?: string
OptionaltlsCertFile?: string

Path to PEM certificate file — enables native TLS on TCP + HTTP (with tlsKeyFile)
OptionaltlsKeyFile?: string

Path to PEM private key file — enables native TLS on TCP + HTTP (with tlsCertFile)

`Optional`storage

storage?: {
    brokerId?: string;
    completedRetentionMs?: number | null;
    dataPath?: string;
    driver?: "memory" | "sqlite" | "postgres";
    idleTransactionTimeoutMs?: number;
    leaseDurationMs?: number;
    lockTimeoutMs?: number;
    maxCompletedJobs?: number;
    maxConcurrentOperations?: number;
    maxQueuedOperations?: number;
    maxRemovedResults?: number;
    maxSnapshotJobs?: number;
    maxSnapshotPayloadBytes?: number;
    namespace?: string;
    pollIntervalMs?: number;
    poolSize?: number;
    removedResultRetentionMs?: number;
    statementTimeoutMs?: number;
    url?: string;
}

Type Declaration

OptionalbrokerId?: string

Stable identifier for this broker process; generated automatically when omitted.
OptionalcompletedRetentionMs?: number | null

Automatic age-based completed-job retention in milliseconds; null disables it.
OptionaldataPath?: string
Optionaldriver?: "memory" | "sqlite" | "postgres"

Persistence backend. Inferred from url/dataPath when omitted.
OptionalidleTransactionTimeoutMs?: number
OptionalleaseDurationMs?: number
OptionallockTimeoutMs?: number
OptionalmaxCompletedJobs?: number

Hot in-memory completed-job window; this is not durable retention.
OptionalmaxConcurrentOperations?: number
OptionalmaxQueuedOperations?: number
OptionalmaxRemovedResults?: number

Maximum retained removed-on-completion results; 0 disables the retention.
OptionalmaxSnapshotJobs?: number
OptionalmaxSnapshotPayloadBytes?: number
Optionalnamespace?: string

Isolates independent bunqueue installations sharing one PostgreSQL database.
OptionalpollIntervalMs?: number
OptionalpoolSize?: number
OptionalremovedResultRetentionMs?: number

Memory-only retention of a removed-on-completion job's result, in ms; 0 disables it.
OptionalstatementTimeoutMs?: number
Optionalurl?: string

PostgreSQL connection URL. Required when driver is postgres.

`Optional`telemetry

telemetry?: { maxPrometheusQueues?: number }

Type Declaration

OptionalmaxPrometheusQueues?: number

Maximum queue label values exposed to Prometheus; zero disables per-queue series.

`Optional`timeouts

timeouts?: { lock?: number; shutdown?: number; stats?: number; worker?: number }

Type Declaration

Optionallock?: number

Ignored (it never took effect; a warning is logged). Set LOCK_TIMEOUT_MS instead.
Optionalshutdown?: number

Graceful-shutdown wait for active jobs, ms (0 = do not wait). Env: SHUTDOWN_TIMEOUT_MS.
Optionalstats?: number

Stats log interval, ms (>= 1). Env: STATS_INTERVAL_MS.
Optionalworker?: number

Ignored (it never took effect; a warning is logged). Set WORKER_TIMEOUT_MS instead.

`Optional`webhooks

webhooks?: { maxRetries?: number; retryDelay?: number }

Type Declaration

OptionalmaxRetries?: number

Ignored (it never took effect; a warning is logged). Set WEBHOOK_MAX_RETRIES instead.
OptionalretryDelay?: number

Ignored (it never took effect; a warning is logged). Set WEBHOOK_RETRY_DELAY_MS instead.

Interface BunqueueConfig

Index

Properties

Properties

Optionalauth

Optionalbackup

Optionalcloud

Optionalcors

Optionallogging

Type Declaration

Optionalformat?: "text" | "json"

Optionallevel?: "info" | "warn" | "error" | "debug"

Optionalserver

Type Declaration

Optionalhost?: string

OptionalhttpPort?: number

OptionalhttpSocketPath?: string

OptionaltcpPort?: number

OptionaltcpSocketPath?: string

OptionaltlsCertFile?: string

OptionaltlsKeyFile?: string

Optionalstorage

Type Declaration

OptionalbrokerId?: string

OptionalcompletedRetentionMs?: number | null

OptionaldataPath?: string

Optionaldriver?: "memory" | "sqlite" | "postgres"

OptionalidleTransactionTimeoutMs?: number

OptionalleaseDurationMs?: number

OptionallockTimeoutMs?: number

OptionalmaxCompletedJobs?: number

OptionalmaxConcurrentOperations?: number

OptionalmaxQueuedOperations?: number

OptionalmaxRemovedResults?: number

OptionalmaxSnapshotJobs?: number

OptionalmaxSnapshotPayloadBytes?: number

Optionalnamespace?: string

OptionalpollIntervalMs?: number

OptionalpoolSize?: number

OptionalremovedResultRetentionMs?: number

OptionalstatementTimeoutMs?: number

Optionalurl?: string

Optionaltelemetry

Type Declaration

OptionalmaxPrometheusQueues?: number

Optionaltimeouts

Type Declaration

Optionallock?: number

Optionalshutdown?: number

Optionalstats?: number

Optionalworker?: number

Optionalwebhooks

Type Declaration

OptionalmaxRetries?: number

OptionalretryDelay?: number

Settings

On This Page

`Optional`auth

`Optional`backup

`Optional`cloud

`Optional`cors

`Optional`logging

`Optional`format?: "text" | "json"

`Optional`level?: "info" | "warn" | "error" | "debug"

`Optional`server

`Optional`host?: string

`Optional`httpPort?: number

`Optional`httpSocketPath?: string

`Optional`tcpPort?: number

`Optional`tcpSocketPath?: string

`Optional`tlsCertFile?: string

`Optional`tlsKeyFile?: string

`Optional`storage

`Optional`brokerId?: string

`Optional`completedRetentionMs?: number | null

`Optional`dataPath?: string

`Optional`driver?: "memory" | "sqlite" | "postgres"

`Optional`idleTransactionTimeoutMs?: number

`Optional`leaseDurationMs?: number

`Optional`lockTimeoutMs?: number

`Optional`maxCompletedJobs?: number

`Optional`maxConcurrentOperations?: number

`Optional`maxQueuedOperations?: number

`Optional`maxRemovedResults?: number

`Optional`maxSnapshotJobs?: number

`Optional`maxSnapshotPayloadBytes?: number

`Optional`namespace?: string

`Optional`pollIntervalMs?: number

`Optional`poolSize?: number

`Optional`removedResultRetentionMs?: number

`Optional`statementTimeoutMs?: number

`Optional`url?: string

`Optional`telemetry

`Optional`maxPrometheusQueues?: number

`Optional`timeouts

`Optional`lock?: number

`Optional`shutdown?: number

`Optional`stats?: number

`Optional`worker?: number

`Optional`webhooks

`Optional`maxRetries?: number

`Optional`retryDelay?: number