NotifyBC
Home
Docs
Help
GitHub
Home
Docs
Help
GitHub
  • Getting Started

    • Welcome
    • Overview
    • Quick Start
    • Installation
    • Web Console
    • What's New
  • Configuration

    • Configuration Overview
    • Database
    • Admin IP List
    • Reverse Proxy IP Lists
    • HTTP Host
    • Internal HTTP Host
    • Email
    • SMS
    • Subscription
    • Notification
    • Node Roles
    • Cron Jobs
    • RSA Keys
    • Worker Process Count
    • Middleware
    • OIDC
    • TLS Certificates
    • Queue
    • Logging
  • API

    • API Overview
    • Subscription
    • Notification
    • Configuration
    • Administrator
    • Bounce
  • Miscellaneous

    • Health Check
    • Disaster Recovery
    • Memory Dump
    • Benchmarks
    • Bulk Import
    • Developer Notes
    • Upgrade Guide
  • Meta

    • Code of Conduct
    • Security Reporting
    • Acknowledgments

Queue

NotifyBC uses BullMQ for notification processing, email and sms throttling. BullMQ is built on top of Redis. Redis connection is defined in config queue.connection with following defaults

module.exports = {
  // ...
  queue: {
    connection: {
      host: '127.0.0.1',
      port: 6379,
    },
  },
};

To override the defaults, set the config in src/config.local.js. More connection parameters are documented in ioredis. For example, to use Sentinel,

module.exports = {
  // ...
  queue: {
    connection: {
      sentinels: [{ host: process.env.REDIS_SERVICE_NAME }],
      name: 'mymaster',
      password: process.env.REDIS_PASSWORD,
      sentinelPassword: process.env.REDIS_PASSWORD,
    },
  },
};

If you deployed NotifyBC using Helm chart, this config is taken care of. If you deployed NotifyBC using docker, Redis is created inside docker using Redis In-Memory Server by default.

Prev
TLS Certificates
Next
Logging