cmaster11/emqx

EMQ Docker

镜像概述和主要用途

EMQ（Erlang MQTT Broker）是一个基于Erlang/OTP构建的分布式、大规模可扩展、高扩展性MQTT消息代理。当前Docker镜像大小为37.1 MB，主要用于物联网（IoT）环境中的消息传输，支持百万级设备连接和高并发消息处理，是构建物联网消息基础设施的核心组件。

核心功能和特性

• 分布式架构：支持集群部署，实现负载均衡与高可用性
• 高扩展性：通过插件系统扩展功能，如认证、授权、数据持久化等
• MQTT协议支持：全面兼容MQTT 3.1/3.1.1/5.0协议标准
• 灵活配置：通过环境变量实现配置参数动态调整
• 轻量级设计：镜像体积仅37.1 MB，资源占用低，部署便捷

使用场景和适用范围

• 物联网设备消息通信：连接大量IoT设备，实现设备间数据交互
• 实时数据处理：适用于工业监控、智能家居等低延迟消息场景
• 分布式系统集成：作为消息中间件连接不同服务组件
• 大规模设备管理：支持百万级设备并发连接与消息路由

使用方法和配置说明

获取并构建镜像

可通过以下命令自行构建Docker镜像：

bash
git clone -b master https://github.com/emqtt/emq_docker.git
cd emq_docker
docker build -t emq:latest .

运行EMQ容器

EMQ容器中，Erlang MQTT Broker以emqtt用户身份运行。基本运行命令格式：

bash
docker run --rm -ti -v `pwd`:/some/path emq/image:tag some_command

基础启动示例：映射管理界面端口（***）和MQTT TCP端口（1883）

bash
docker run --rm -ti --name emq -p 18083:18083 -p 1883:1883 emq:latest

配置说明

通过环境变量配置EMQ容器，遵循以下映射规则：

• 前缀为EMQ_的环境变量映射到配置文件，配置项中的.替换为__（双下划线）
  • 示例：EMQ_LISTENER__SSL__EXTERNAL__ACCEPTORS 对应配置项 listener.ssl.external.acceptors
• 前缀为PLATFORM_的环境变量映射到配置文件模板字符串
  • 示例：PLATFORM_ETC_DIR 对应模板 {{ platform_etc_dir }}
• 不参与配置映射的特殊变量：EMQ_NAME、EMQ_HOST

EMQ核心配置

注意：https://github.com/emqtt/emqttd/blob/master/etc/emq.conf%E4%B8%AD%E7%9A%84%E6%89%80%E6%9C%89%E9%85%8D%E7%BD%AE%E5%9D%87%E5%8F%AF%E9%80%9A%E8%BF%87%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E8%AE%BE%E7%BD%AE%EF%BC%8C%E4%BB%A5%E4%B8%8B%E4%B8%BA%E5%B8%B8%E7%94%A8%E9%85%8D%E7%BD%AE%E9%A1%B9%E7%A4%BA%E4%BE%8B%EF%BC%9A

配置示例：修改MQTT TCP端口为1883

bash
docker run --rm -ti --name emq -e EMQ_LISTENER__TCP__EXTERNAL=1883 -p 18083:18083 -p 1883:1883 emq:latest

插件加载配置

默认加载插件说明：

• emq_recon：系统监控与诊断
• emq_modules：核心功能模块
• emq_retainer：消息留存服务
• emq_dashboard：Web管理界面

插件加载示例：添加emq_auth_redis认证插件（支持任意分隔符）

bash
# 逗号分隔
EMQ_LOADED_PLUGINS="emq_auth_redis,emq_recon,emq_modules,emq_retainer,emq_dashboard"
# 空格分隔
EMQ_LOADED_PLUGINS="emq_auth_redis emq_recon emq_modules emq_retainer emq_dashboard"

插件参数配置

插件配置同样遵循EMQ_前缀和.转__规则。例如：

• EMQ_AUTH__REDIS__SERVER 对应 auth.redis.server
• EMQ_AUTH__REDIS__PASSWORD 对应 auth.redis.password

Redis认证插件配置示例：

bash
docker run --rm -ti --name emq -p 18083:18083 -p 1883:1883 -p 4369:4369 \
    -e EMQ_LISTENER__TCP__EXTERNAL=1883 \
    -e EMQ_LOADED_PLUGINS="emq_auth_redis,emq_recon,emq_modules,emq_retainer,emq_dashboard" \
    -e EMQ_AUTH__REDIS__SERVER="your.redis.server:6379" \
    -e EMQ_AUTH__REDIS__PASSWORD="password_for_redis" \
    -e EMQ_AUTH__REDIS__PASSWORD_HASH=plain \
    emq:latest

集群部署

部署EMQ集群需暴露端口4369（Erlang分布式端口）和6000-6999（集群通信端口范围）。

集群加入示例：

bash
docker run --rm -ti --name emq -p 18083:18083 -p 1883:1883 -p 4369:4369 -p 6000-6100:6000-6100 \
    -e EMQ_NAME="emq" \
    -e EMQ_HOST="s2.emqtt.io" \
    -e EMQ_LISTENER__TCP__EXTERNAL=1883 \
    -e EMQ_JOIN_CLUSTER="emq@s1.emqtt.io" \
    emq:latest

内核调优

推荐在Linux主机直接调优内核参数（参考http://emqttd-docs.readthedocs.io/en/latest/tune.html%EF%BC%89%E3%80%82%E8%8B%A5%E9%9C%80%E9%80%9A%E8%BF%87Docker%E8%B0%83%E4%BC%98%EF%BC%8C%E7%A1%AE%E4%BF%9DDocker%E7%89%88%E6%9C%AC%E2%89%A51.12%EF%BC%8C%E4%BD%BF%E7%94%A8%60--sysctl%60%E5%8F%82%E6%95%B0%EF%BC%9A

bash
docker run --rm -ti --name emq -p 18083:18083 -p 1883:1883 -p 4369:4369 \
    --sysctl fs.file-max=2097152 \
    --sysctl fs.nr_open=2097152 \
    --sysctl net.core.somaxconn=32768 \
    --sysctl net.ipv4.tcp_max_syn_backlog=16384 \
    --sysctl net.core.netdev_max_backlog=16384 \
    --sysctl net.ipv4.ip_local_port_range=1000 65535 \
    --sysctl net.core.rmem_default=262144 \
    --sysctl net.core.wmem_default=262144 \
    --sysctl net.core.rmem_max=16777216 \
    --sysctl net.core.wmem_max=16777216 \
    --sysctl net.core.optmem_max=16777216 \
    --sysctl net.ipv4.tcp_rmem=1024 4096 16777216 \
    --sysctl net.ipv4.tcp_wmem=1024 4096 16777216 \
    --sysctl net.ipv4.tcp_max_tw_buckets=1048576 \
    --sysctl net.ipv4.tcp_fin_timeout=15 \
    emq:latest

安全提示：不要以特权模式运行EMQ容器或挂载系统proc目录进行内核调优，存在安全风险。