tfgco/arkadiko

Arkadiko Docker镜像文档

镜像概述和主要用途

Arkadiko是一款轻量级的协议桥接工具，核心功能是在HTTP协议与MQTT协议之间建立通信桥梁，实现两种协议间的消息转发。通过该工具，可将HTTP请求转换为MQTT消息并发布到指定主题，或订阅MQTT主题将消息转换为HTTP请求发送至目标端点，解决跨协议通信场景下的集成问题。

核心功能和特性

• 协议转换：支持HTTP与MQTT双向消息转换，实现HTTP请求到MQTT消息的发布，以及MQTT消息到HTTP请求的转发
• 轻量部署：基于Docker容器化设计，资源占用低，可快速部署于各类环境
• 灵活配置：通过环境变量或配置文件自定义MQTT连接参数、HTTP监听端口及消息转发规则
• 兼容性强：兼容标准MQTT协议（v3.1.1/v5.0）及HTTP 1.1协议，适配主流MQTT broker（如Mosquitto、EMQX）

使用场景和适用范围

• IoT系统集成：Web应用、移动客户端等HTTP设备需向MQTT物联网设备发送控制指令
• 数据采集转发：传感器通过HTTP上报数据，需转发至MQTT消息队列供后端服务订阅处理
• 跨平台消息同步：在基于HTTP的Web服务与基于MQTT的物联网平台间实现消息实时同步
• 边缘计算场景：在资源受限的边缘设备中，实现轻量级协议转换，连接云端HTTP服务与本地MQTT设备网络

使用方法和配置说明

基本部署命令（Docker Run）

bash
docker run -d \
  --name arkadiko \
  -p 8080:8080 \  # HTTP服务端口映射
  -e MQTT_BROKER=mqtt.example.com \  # MQTT broker地址
  -e MQTT_PORT=1883 \  # MQTT broker端口
  -e HTTP_LISTEN_PORT=8080 \  # 容器内HTTP监听端口
  arkadiko/arkadiko:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  arkadiko:
    image: arkadiko/arkadiko:latest
    container_name: arkadiko
    ports:
      - "8080:8080"
    environment:
      - MQTT_BROKER=mosquitto  # 可关联同网络中的MQTT服务
      - MQTT_PORT=1883
      - MQTT_USERNAME=user  # MQTT认证用户名（可选）
      - MQTT_PASSWORD=pass  # MQTT认证密码（可选）
      - HTTP_LISTEN_PORT=8080
      - MQTT_TOPIC_PREFIX=/http-bridge/  # MQTT消息发布主题前缀
    networks:
      - mqtt-network  # 与MQTT broker共享网络

networks:
  mqtt-network:
    external: true  # 假设已存在mqtt-network网络

核心配置参数（环境变量）

消息转发使用示例

1. HTTP请求转发至MQTT

向Arkadiko的HTTP端点发送POST请求，内容将被转换为MQTT消息发布到指定主题：

bash
# 发送HTTP POST请求，消息将发布到MQTT主题：/sensors/temp
curl -X POST http://localhost:8080/publish/sensors/temp \
  -H "Content-Type: application/json" \
  -d '{"value": 26.5, "unit": "celsius"}'

2. MQTT消息转发至HTTP

配置MQTT订阅规则后（通过环境变量MQTT_SUBSCRIBE_TOPICS=/devices/#），Arkadiko会将订阅到的MQTT消息转发至指定HTTP端点：

bash
# 假设配置HTTP转发目标为http://api.example.com/webhook
# 当MQTT主题/devices/device1收到消息时，Arkadiko会自动向上述URL发送POST请求，内容为MQTT消息体

高级配置说明

如需自定义复杂转发规则（如消息格式转换、主题映射），可通过挂载配置文件实现：

bash
docker run -d \
  --name arkadiko \
  -p 8080:8080 \
  -v ./config.yaml:/app/config.yaml \  # 挂载本地配置文件
  arkadiko/arkadiko:latest

配置文件（config.yaml）示例：

yaml
mqtt:
  broker: mqtt.example.com
  port: 8883
  tls: true
  username: admin
  password: securepass
  subscribe:
    - topic: /devices/#
      qos: 1
      http_endpoint: [***]
http:
  port: 8080
  endpoints:
    - path: /publish
      topic_template: /http/{{.PathParams.topic}}
      methods: [POST, PUT]