RMQTT Broker

English | 简体中文

RMQTT broker is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and mobile applications that can handle millions of concurrent clients on a single service node.

Features

• 100% Rust safe code;

• Based on tokio;

• MQTT v3.1, v3.1.1 and v5.0 protocols support;

  • QoS0, QoS1, QoS2 message support;
  • Offline message support;
  • Retained message support;
  • Last Will message support;

• Distributed cluster;

• Built-in AUTH/ACL;

• HTTP AUTH/ACL;

• JWT AUTH/ACL;

• WebHook;

• HTTP APIs;

• $SYS System Topics;

• Store session information;

• Store unexpired messages;

• MQTT Bridging - Ingress Mode;

• MQTT Bridging - Egress Mode;

• Apache Kafka Bridging - Ingress Mode;

• Apache Kafka Bridging - Egress Mode;

• Apache Pulsar Bridging - Ingress Mode;

• Apache Pulsar Bridging - Egress Mode;

• NATS Bridging - Ingress Mode;

• NATS Bridging - Egress Mode;

• Reductstore Bridging - Egress Mode;

• Topic Rewrite;

• Auto Subscription;

• P2P Messaging;

• Shared subscription($share/{Group}/{TopicFilter});

• Exclusive subscription($exclusive/{TopicFilter});

• Limit subscription($limit/{LimitQuantity}/{TopicFilter});

• Delayed publish($delayed/{DelayInterval}/{TopicName});

• Hooks;

• TLS support;

• WebSocket support;

• WebSocket-TLS support;

• MQTT over QUIC support;

• Built-in extensible components;

• Extensible plug-in support;

• Metrics & Stats;

• Rate limit;

• Inflight and Queue;

• Message resending;

• For full list of new features, please read RMQTT Release Notes.

Installation

The RMQTT broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means RMQTT can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.

Run RMQTT using Docker

• Single node

mkdir -p /app/log/rmqtt
docker run -d --name rmqtt -p 1883:1883 -p 8883:8883 -p 11883:11883 -p 6060:6060 -v /app/log/rmqtt:/var/log/rmqtt  rmqtt/rmqtt:latest

• Multi node

  docker run -d --name rmqtt1 -p 1884:1883 -p 8884:8883 -p 11884:11883 -p 6064:6060 -v /app/log/rmqtt/1:/var/log/rmqtt  rmqtt/rmqtt:latest --id 1 --plugins-default-startups "rmqtt-cluster-raft" --node-grpc-addrs "[email protected]:5363" "[email protected]:5363" "[email protected]:5363" --raft-peer-addrs "[email protected]:6003" "[email protected]:6003" "[email protected]:6003"   

  docker run -d --name rmqtt2 -p 1885:1883 -p 8885:8883 -p 11885:11883 -p 6065:6060 -v /app/log/rmqtt/2:/var/log/rmqtt  rmqtt/rmqtt:latest --id 2 --plugins-default-startups "rmqtt-cluster-raft" --node-grpc-addrs "[email protected]:5363" "[email protected]:5363" "[email protected]:5363" --raft-peer-addrs "[email protected]:6003" "[email protected]:6003" "[email protected]:6003"   

  docker run -d --name rmqtt3 -p 1886:1883 -p 8886:8883 -p 11886:11883 -p 6066:6060 -v /app/log/rmqtt/3:/var/log/rmqtt  rmqtt/rmqtt:latest --id 3 --plugins-default-startups "rmqtt-cluster-raft" --node-grpc-addrs "[email protected]:5363" "[email protected]:5363" "[email protected]:5363" --raft-peer-addrs "[email protected]:6003" "[email protected]:6003" "[email protected]:6003"

Node IDs: 1, 2, 3; Node IP Addrs: 172.17.0.3, 172.17.0.4, 172.17.0.5

Create a single node by docker-compose

# docker-compose.yaml
version: '3'

services:
  rmqtt:
    container_name: rmqtt
    image: rmqtt/rmqtt:latest
    volumes:
      - /etc/localtime:/etc/localtime
      - /app/rmqtt-single/etc/:/app/rmqtt/etc
      - /app/rmqtt-single/log:/var/log/rmqtt
    ports:
      - "1883:1883"
      - "8080:8080"
      - "8883:8883"
      - "11883:11883"
      - "6060:6060"
    restart: always
    command: -f ./etc/rmqtt.toml --id 1
    privileged: true

Create a static cluster by docker-compose

1. Download docker-compose configuration template

2. Start docker-compose cluster

docker-compose up -d

3. View cluster

curl "http://127.0.0.1:6066/api/v1/health/check"

Installing via ZIP Binary Package (Linux、MacOS、Windows)

Get the binary package of the corresponding OS from RMQTT Download page.

• Single Node Install

• Multi Node Install

Library Mode Integration

In addition to running as a standalone MQTT Broker/Server, rmqtt also provides a Library Mode, which allows you to embed rmqtt directly into your Rust applications or services. Simply add the following dependency to your Cargo.toml, and you can use rmqtt's APIs just like a regular Rust library:

[dependencies]
rmqtt = "0.21"

For more details about using rmqtt in library mode, please refer to the RMQTT Library Documentation.

Plugin System

RMQTT has 25 built-in plugins across 6 categories:

Plugin Development Guide →

Documentation

Test

Interoperability Testing

paho.mqtt.testing(MQTT V3.1.1) client_test.py

• client_test.py Test.test_retained_messages [OK]
• client_test.py Test.test_zero_length_clientid [OK]
• client_test.py Test.will_message_test [OK]
• client_test.py Test.test_offline_message_queueing [OK]
• client_test.py Test.test_overlapping_subscriptions [OK]
• client_test.py Test.test_keepalive [OK]
• client_test.py Test.test_redelivery_on_reconnect [OK]
• client_test.py Test.test_dollar_topics [OK]
• client_test.py Test.test_unsubscribe [OK]
• client_test.py Test.test_subscribe_failure [OK]
  • You need to modify the rmqtt-acl.toml configuration and add the following line at the first line: ["deny", "all", "subscribe", ["test/nosubscribe"]]

paho.mqtt.testing(MQTT V5.0) client_test5.py

• client_test5.py Test.test_retained_message [OK]
• client_test5.py Test.test_will_message [OK]
• client_test5.py Test.test_offline_message_queueing [OK]
• client_test5.py Test.test_dollar_topics [OK]
• client_test5.py Test.test_unsubscribe [OK]
• client_test5.py Test.test_session_expiry [OK]
• client_test5.py Test.test_shared_subscriptions [OK]
• client_test5.py Test.test_basic [OK]
• client_test5.py Test.test_overlapping_subscriptions [OK]
• client_test5.py Test.test_redelivery_on_reconnect [OK]
• client_test5.py Test.test_payload_format [OK]
• client_test5.py Test.test_publication_expiry [OK]
• client_test5.py Test.test_subscribe_options [OK]
• client_test5.py Test.test_assigned_clientid [OK]
• client_test5.py Test.test_subscribe_identifiers [OK]
• client_test5.py Test.test_request_response [OK]
• client_test5.py Test.test_server_topic_alias [OK]
• client_test5.py Test.test_client_topic_alias [OK]
• client_test5.py Test.test_maximum_packet_size [OK]
• client_test5.py Test.test_keepalive [OK]
• client_test5.py Test.test_zero_length_clientid [OK]
• client_test5.py Test.test_user_properties [OK]
• client_test5.py Test.test_flow_control2 [OK]
• client_test5.py Test.test_flow_control1 [OK]
• client_test5.py Test.test_will_delay [OK]
• client_test5.py Test.test_server_keep_alive [OK]
  • You need to modify the rmqtt.toml configuration and change max_keepalive to 60.
• client_test5.py Test.test_subscribe_failure [OK]
  • You need to modify the rmqtt-acl.toml configuration and add the following line at the first line: ["deny", "all", "subscribe", ["test/nosubscribe"]]

Integration Test Harness

The rmqtt-test crate provides a custom test harness with functional, stress, and chaos suites beyond paho. See Test Report for details.

Benchmark

Environment

Connection Concurrency Performance

Message Throughput Performance

For detailed benchmark test results and information, see documentation.

Credits

• Starting from version 0.15, the MQTT encoding and decoding implementation is partially inspired by and derived from ntex-mqtt.

• For versions 0.13 and earlier, this project relied on maintained forked versions of the ntex and ntex-mqtt crates as dependencies.

License

Licensed under either of MIT or Apache 2.0 at your option.