efrecon/mqtt2any

mqtt2any 镜像说明

镜像概述

efrecon/mqtt2any是一款通用MQTT订阅处理工具，能够将MQTT主题订阅的数据路由至沙箱化Tcl解释器进行自定义处理，同时支持在不同MQTT服务器间转发主题数据。沙箱机制可限制解释器的磁盘访问和网络通信范围，确保安全性；提供丰富的配置选项，适配多样化的MQTT数据处理场景。

核心功能

1. MQTT订阅路由：将指定主题的MQTT消息路由到自定义Tcl脚本执行处理逻辑。
2. 沙箱安全控制：Tcl解释器运行在沙箱环境中，可通过配置限制其磁盘访问路径、网络通信主机及端口。
3. 跨Broker转发：支持将MQTT数据从一个Broker转发到另一个Broker，并可配置速率限制。
4. 灵活配置方式：通过命令行选项设置Broker连接、路由规则、重连策略等；支持从文件或命令加载敏感配置值（如密码）。
5. 扩展插件机制：可通过外部目录加载自定义Tcl插件，实现数据转换、过滤、日志等多样化需求。

使用场景

• 数据处理：对MQTT消息进行自定义转换、过滤或日志记录（如打印消息内容）。
• 跨环境同步：在测试与生产环境的MQTT服务器间复制主题数据。
• 流量管控：对转发的MQTT消息设置速率限制，避免目标Broker过载。

配置说明

主要命令行选项

• -broker：MQTT Broker地址（格式：mqtt://user:pass@host:port，支持mqtts://加密）。
• -routes：路由规则三元组（主题订阅、处理脚本、沙箱选项），示例："$SYS/# print@printer.tcl \"\""。
• -exts：插件目录路径，用于加载自定义Tcl脚本。
• -keepalive：MQTT保活周期（默认60秒）。
• -retry：断开重连策略（支持固定间隔或指数退避，如1000:5000:2）。
• -qos：订阅QoS级别（默认1）。

沙箱配置选项（路由规则中使用）

• -access：允许解释器访问的磁盘路径。
• -allow：允许解释器通信的主机和端口（格式：host:port）。
• -deny：禁止解释器通信的主机和端口。
• -environment：传递环境变量到解释器（如-environment MQTT_BROKER=mqtt://broker.hivemq.com）。

Docker部署示例

基本使用（打印测试Broker消息）

bash
docker run --rm efrecon/mqtt2any \
  -broker mqtt://test.mosquitto.org \
  -routes "\$SYS/# print@printer.tcl \"\""

使用自定义插件

将本地插件目录挂载到容器的/var/mqtt2any/exts路径：

bash
docker run --rm \
  -v /path/to/your/plugins:/var/mqtt2any/exts \
  efrecon/mqtt2any \
  -broker mqtt://your-broker \
  -routes "your/topic/# your_procedure@your_script.tcl \"-access /data -allow your-host:8080\""

MQTT转发示例（带速率限制）

将bbc/#主题数据从test.mosquitto.org转发到hivemq Broker，并设置速率限制：

bash
docker run --rm efrecon/mqtt2any \
  -broker mqtt://test.mosquitto.org \
  -routes "bbc/# *** \"-alias {smqtt smqtt} -environment MQTT_BROKER=mqtt://broker.hivemq.com -environment MQTT_LIMITS=bbc/# on 5s 5 -1\""