rgitzel/mqttwarn-full

mqttwarn-full镜像说明

镜像概述

mqttwarn-full是包含所有依赖项的mqttwarn工具镜像，用于实现MQTT消息与多种通知服务的桥接。它能够订阅MQTT主题（支持通配符），将接收到的消息转发至指定的通知渠道，并支持自定义插件扩展服务类型、消息过滤与格式转换。

核心功能

1. MQTT主题订阅：支持多主题订阅，包含通配符（如test/+），接收消息并分发。
2. 多通知服务集成：覆盖数十种服务（如SMTP邮件、Pushover、Slack、***、InfluxDB、MySQL等）。
3. 自定义扩展：允许编写插件添加新服务，或通过模板/函数实现消息内容转换与过滤。
4. 灵活配置：通过ini文件定义MQTT broker参数、服务配置、主题与通知渠道的映射规则。
5. 故障转移：支持故障处理配置，当MQTT broker断开时发送错误通知。

使用场景

• IoT监控：传感器低电量、环境异常时推送告警到手机或邮件。
• 系统运维：服务器负载过高、服务异常时发送通知到团队协作工具（如Slack）。
• 数据转发：将MQTT消息存储到数据库（如MySQL）或转发到其他消息系统（如AMQP）。

配置说明

1. 配置文件：需创建mqttwarn.ini，关键部分包括：
   • [defaults]：MQTT broker地址、端口、认证信息等基础配置。
   • [config:xxx]：各通知服务的具体参数（如SMTP服务器地址、Pushover API密钥）。
   • [topic/xxx]：MQTT主题与通知服务的映射规则（如test/+对应邮件和日志服务）。
2. 示例配置：参考官方mqttwarn.ini.sample文件，修改后使用。

Docker部署示例

运行镜像（映射配置文件）

bash
docker run -d \
  --name mqttwarn-full \
  -v /path/to/your/mqttwarn.ini:/app/mqttwarn.ini \
  --network host \  # 若MQTT broker在本地网络，建议使用host网络
  rgitzel/mqttwarn-full

构建自定义镜像（可选）

bash
git clone https://github.com/jpmens/mqttwarn.git
cd mqttwarn
docker build -t mqttwarn-full .