Skip to main content

Get Started

This guide starts a single YedMQ node from source.

caution

YedMQ is under active development and is not yet recommended for production workloads.

Prerequisites​

  • Rust 1.75 or newer
  • protoc
  • Optional: mosquitto_pub and mosquitto_sub for quick verification

1. Clone and build​

git clone https://github.com/designershao/YedMQ.git
cd YedMQ
cargo build --release -p yedmq

2. Create a local config file​

cp yedmq.toml.example yedmq.toml

Review the listener, API auth, cluster, and plugin settings before starting the broker.

3. Start the broker​

RUST_LOG=info ./target/release/yedmq

YedMQ loads ./yedmq.toml from the current working directory, so run the binary from the project root unless you wrap startup with your own config-loading logic.

4. Verify MQTT connectivity​

Open one terminal:

mosquitto_sub -h 127.0.0.1 -p 1883 -t test/topic

Open another terminal:

mosquitto_pub -h 127.0.0.1 -p 1883 -t test/topic -m "hello yedmq"

5. Verify the management API​

The example config enables Basic Authentication for the REST API:

curl -u admin:change_me_in_production http://127.0.0.1:3456/api/v1/system_info

Next steps​