pongsky/rocketmq-console-ng

RocketMQ控制台镜像文档

镜像概述

本镜像基于Apache RocketMQ官方https://github.com/apache/rocketmq-externals/tree/master/rocketmq-console%E4%BB%A3%E7%A0%81%E9%87%8D%E6%96%B0%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%97%A8%E5%9C%A8%E8%A7%A3%E5%86%B3%E5%AE%98%E6%96%B9%E7%A4%BA%E4%BE%8B%E6%8E%A8%E8%8D%90%E7%9A%84https://hub.docker.com/r/styletang/rocketmq-console-ng%E9%95%9C%E5%83%8F%E4%B8%89%E5%B9%B4%E5%A4%9A%E6%9C%AA%E6%9B%B4%E6%96%B0%E3%80%81%E6%8E%A7%E5%88%B6%E5%8F%B0%E7%99%BB%E5%BD%95%E9%89%B4%E6%9D%83%E7%AD%89%E6%96%B0%E5%8A%9F%E8%83%BD%E7%BC%BA%E5%A4%B1%E7%9A%84%E9%97%AE%E9%A2%98%EF%BC%8C%E6%8F%90%E4%BE%9B%E6%94%AF%E6%8C%81%E6%9C%80%E6%96%B0%E5%8A%9F%E8%83%BD%E7%9A%84RocketMQ%E7%AE%A1%E7%90%86%E6%8E%A7%E5%88%B6%E5%8F%B0%E3%80%82

核心功能与特性

• 默认启用登录鉴权：rocketmq.config.loginRequired配置项默认设为true，强制控制台登录验证
• 与官方代码同步：基于最新官方代码构建，支持官方示例未包含的新功能
• 配置兼容性：保持与官方application.properties配置格式兼容，易于迁移和配置

配置说明

官方application.properties配置

text
# 若该值为空，将使用环境变量rocketmq.config.namesrvAddr或NAMESRV_ADDR；也可在操作页面设置，默认localhost:9876
rocketmq.config.namesrvAddr=

# 若使用RocketMQ版本<3.5.8，rocketmq.config.isVIPChannel应设为false，默认true
rocketmq.config.isVIPChannel=

# 若启用登录鉴权，必须创建用户信息文件：${rocketmq.config.dataPath}/users.properties
rocketmq.config.loginRequired=true

使用场景

• 需要对RocketMQ集群进行可视化管理的场景
• 生产环境中需对控制台访问进行权限控制的场景
• 官方控制台镜像功能无法满足需求的场景

使用方法

docker-compose部署示例

以下是完整的RocketMQ集群（包含namesrv、broker和console）部署配置：

yml
version: '3.7'
services:
  rmqnamesrv:
    image: foxiswho/rocketmq:server-4.6.1
    container_name: rmqnamesrv
    ports:
      - 9876:9876
    volumes:
      - ./data/rocketmq/server/logs:/opt/logs  # 日志目录挂载
      - ./data/rocketmq/server/store:/opt/store  # 数据存储目录挂载
    networks:
        rmq:
          aliases:
            - rmqnamesrv

  rmqbroker:
    image: foxiswho/rocketmq:broker-4.6.1
    container_name: rmqbroker
    ports:
      - 10909:10909  # 客户端通信端口
      - 10911:10911  #  Broker服务端口
    volumes:
      - ./data/rocketmq/broker/logs:/opt/logs  # 日志目录挂载
      - ./data/rocketmq/broker/store:/opt/store  # 数据存储目录挂载
      - ./data/rocketmq/broker/config/broker.conf:/etc/rocketmq/broker.conf  # broker配置文件挂载
    environment:
        NAMESRV_ADDR: "rmqnamesrv:9876"  # namesrv地址
        JAVA_OPTS: " -Duser.home=/opt"  # Java环境变量
        JAVA_OPT_EXT: "-server -Xms128m -Xmx128m -Xmn128m"  # JVM参数
    command: mqbroker -c /etc/rocketmq/broker.conf  # 使用指定配置文件启动broker
    depends_on:
      - rmqnamesrv  # 依赖namesrv服务
    networks:
      rmq:
        aliases:
          - rmqbroker

  rmqconsole:
    image: pongsky/rocketmq-console-ng
    container_name: rmqconsole
    ports:
      - 8888:8080  # 控制台访问端口
    environment:
      JAVA_OPTS: "-Drocketmq.config.namesrvAddr=rmqnamesrv:9876"  # 指定namesrv地址
    volumes: 
      - ./data/rocketmq/console/data/users.properties:/tmp/rocketmq-console/data/users.properties  # 用户配置文件挂载
    depends_on:
      - rmqnamesrv  # 依赖namesrv服务
    networks:
      rmq:
        aliases:
          - rmqconsole
networks:
  rmq:
    name: rmq
    driver: bridge

关键配置说明

1. 用户配置文件：

   • 启用登录鉴权时，需创建users.properties文件并挂载到容器/tmp/rocketmq-console/data/users.properties路径
   • 文件格式示例：username=password,role（role可设为admin或普通用户）

2. 环境变量配置：

   • rocketmq.config.namesrvAddr：指定RocketMQ namesrv地址，格式为host:port
   • 其他配置可通过JAVA_OPTS以-Dproperty=value形式传递

3. 访问控制台：

   • 部署完成后，通过http://<主机IP>:8888访问控制台
   • 使用users.properties中配置的用户名密码登录