bull-board Docker镜像文档

镜像概述

本镜像为bull-board提供容器化部署方案，bull-board是一个用于监控bull和bullmq队列的UI工具。无需编写代码即可直观查看队列状态、任务信息等。支持bull和bullmq两种队列库，基于bull-board v2.0.3版本构建。

核心功能与特性

• 多版本支持：同时兼容bull和bullmq队列库
• 零编码配置：通过环境变量即可完成所有配置
• 灵活的Redis连接：支持配置Redis主机、端口、数据库、密码及TLS
• 访问控制：可通过用户名密码限制界面访问
• 路径代理：支持设置代理路径，适应复杂部署环境

使用场景

适用于需要监控基于bull或bullmq构建的任务队列的开发和运维场景，帮助实时掌握队列状态、任务执行情况及异常信息。

使用方法

Docker快速启动

通过以下命令快速启动bull-board：

bash
docker run -p 3000:3000 deadly0/bull-board

启动后，访问localhost:3000即可打开监控界面。默认连接本地Redis（localhost:6379，无密码）。

docker-compose快速启动

基础docker-compose配置：

yaml
version: '3.5'

services:
  bullboard:
    container_name: bullboard
    image: deadly0/bull-board
    restart: always
    ports:
      - 3000:3000

启动后同样访问localhost:3000，默认连接本地Redis。更多带环境变量的配置示例见下文"docker-compose完整示例"。

环境变量配置

通过环境变量可自定义镜像行为，支持以下参数：

访问控制配置

通过同时设置USER_LOGIN和USER_PASSWORD环境变量可启用界面访问控制，只有输入正确的用户名和密码才能访问监控界面。

docker-compose完整示例

以下示例包含Redis服务及完整环境变量配置：

yaml
version: '3.5'

services:
  redis:
    container_name: redis
    image: redis:5.0-alpine
    restart: always
    ports:
      - 6379:6379
    volumes:
      - redis_db_data:/data

  bullboard:
    container_name: bullboard
    image: deadly0/bull-board
    restart: always
    ports:
      - 3000:3000
    environment:
      REDIS_HOST: redis
      REDIS_PORT: 6379
      REDIS_PASSWORD: example-password
      REDIS_USE_TLS: 'false'
      BULL_PREFIX: bull
      BULL_VERSION: BULLMQ
    depends_on:
      - redis

volumes:
  redis_db_data:
    external: false