English | 简体中文

rmqttd

Official binary entry point for the RMQTT MQTT broker.

What it does

• Startup flow: Parse CLI args → initialize rmqtt_conf::Settings singleton → install rustls crypto backend → init tracing logger → create rmqtt::context::ServerContext → start gRPC server → register plugins from Cargo.toml metadata → bind configured listeners → start MQTT server
• Build-time plugin registration: build.rs reads [package.metadata.plugins] from Cargo.toml, auto-generates plugin.rs with a registers() function. Each plugin is registered based on default_startup and immutable flags
• Listener types: TCP, TLS, WebSocket (WS), TLS-WebSocket (WSS), QUIC
• Signal handling: Ctrl+C on Windows, SIGTERM + SIGINT on Unix; 100ms graceful delay before exit
• Logging: Configured via rmqtt_conf::logging::Log — supports off/console/file/both modes, UTC+8 timestamps, non-blocking file writer
• Linux allocator: Uses tikv-jemallocator as the default memory allocator on Linux

Build

cargo build -p rmqttd --release
# Artifact: target/release/rmqttd (or rmqttd.exe)

Run

./target/release/rmqttd
./target/release/rmqttd -f /path/to/rmqtt.toml
./target/release/rmqttd --config /path/to/rmqtt.toml
./target/release/rmqttd --id 1

CLI arguments

Defined by rmqtt_conf::Options (via clap::Parser):

Configuration

Loaded by rmqtt_conf::Settings from the following paths (in priority order):

1. /etc/rmqtt/rmqtt.{toml,json,...} (optional)
2. /etc/rmqtt.{toml,json,...} (optional)
3. ./rmqtt.{toml,json,...} (optional)
4. -f / --config specified file (optional)
5. RMQTT_* environment variables

Docker

Three Dockerfiles for different architectures:

• Dockerfile — default
• Dockerfile.amd64 — x86_64
• Dockerfile.aarch64 — ARM64

docker build -t rmqttd .

Related crates

• rmqtt — Core MQTT Broker library
• rmqtt-conf — Configuration management
• rmqtt-plugins — Plugin collection

License

MIT OR Apache-2.0