venatum/bull-board

bull-board Docker镜像文档

概述

本Docker镜像基于bull-board（v6.13.1）构建，提供无需编码即可监控bull和bullmq队列的Web界面。通过简单配置即可连接Redis，支持标准Redis连接及Sentinel模式，适用于各类需要监控后台任务队列状态的场景。

重要提示：自v2.0.0版本起，因Node.js 20在32位模式下存在问题，镜像不再支持32位系统。

核心功能与特性

• 零编码监控：无需编写代码，直接通过Web界面查看队列状态
• 多队列支持：兼容bull和bullmq两种队列库
• 灵活的Redis连接：支持标准Redis配置及Sentinel模式
• 访问控制：可通过用户名密码限制界面访问
• 自定义配置：丰富的环境变量支持Redis连接、队列前缀、UI样式等定制
• 健康检查：提供/healthcheck端点监控容器及Redis状态

使用场景

• 监控基于bull或bullmq实现的后台任务队列（如定时任务、异步处理等）
• 需要快速查看队列任务数量、状态、失败原因的开发/运维场景
• 需对队列访问进行权限控制的生产环境
• 使用Redis Sentinel模式部署的高可用队列系统监控

快速开始

Docker快速启动

bash
docker run -p 3000:3000 venatum/bull-board:latest

• 界面将运行在localhost:3000
• 默认连接本地Redis（localhost:6379，无密码，数据库0）

Docker Compose快速启动

yaml
services:
    bullboard:
        container_name: bullboard
        image: venatum/bull-board
        restart: unless-stopped
        ports:
            - "3000:3000"

• 界面将运行在localhost:3000
• 默认连接本地Redis（localhost:6379，无密码，数据库0）
• 如需自定义配置，见下方"环境变量"及"完整示例"

Redis Sentinel模式

支持通过Redis Sentinel模式连接队列，需配置Sentinel相关环境变量。注意：Sentinel模式下，界面中的"Redis服务器信息"按钮可能无法正常工作。

环境变量配置

Redis基础配置

Sentinel高级配置

Redis高级配置

界面配置

队列配置

BullBoard UI配置

基于https://github.com/felixmosh/bull-board/tree/master?tab=readme-ov-file#board-options%EF%BC%8C%E9%BB%98%E8%AE%A4%E5%80%BC%E4%B8%8E%E5%8E%9F%E9%A1%B9%E7%9B%AE%E4%B8%80%E8%87%B4%EF%BC%9A

访问控制配置

通过设置USER_LOGIN和USER_PASSWORD环境变量限制界面访问，需同时配置两个变量：

bash
docker run -p 3000:3000 \
  -e USER_LOGIN=admin \
  -e USER_PASSWORD=secret \
  venatum/bull-board:latest

访问localhost:3000时将提示输入用户名密码。

健康检查

容器提供/healthcheck端点，返回JSON格式健康状态：

json
{
  "status": "ok",
  "info": {
    "redis": {
      "status": "up",
      "description": "Based on the Redis PING/PONG system"
    }
  }
}

完整Docker Compose示例

yaml
services:
    redis:
        container_name: redis
        image: redis:alpine
        restart: unless-stopped
        ports:
            - "6379:6379"
        volumes:
            - redis_db_data:/data

    bullboard:
        container_name: bullboard
        image: venatum/bull-board:latest
        restart: unless-stopped
        environment:
            REDIS_HOST: redis          # 连接Redis服务名
            REDIS_PORT: 6379           # Redis端口
            REDIS_PASSWORD: example-password  # Redis密码
            REDIS_USE_TLS: 'false'     # 禁用TLS
            BULL_PREFIX: bull          # 队列前缀
            USER_LOGIN: admin          # 访问用户名
            USER_PASSWORD: secure123   # 访问密码
        ports:
            - "3000:3000"
        depends_on:
            - redis

volumes:
    redis_db_data:
        external: false

项目地址

• https://github.com/felixmosh/bull-board
• https://github.com/Venatum/bull-board-docker