Skip to content

Latest commit

 

History

History
154 lines (106 loc) · 4.28 KB

README.md

File metadata and controls

154 lines (106 loc) · 4.28 KB
rumqtt Logo

What is rumqtt?

rumqtt is an opensource set of libraries written in rust-lang to implement the MQTT standard while striving to be simple, robust and performant.

Crate Description version
rumqttc A high level, easy to use mqtt client crates.io page
rumqttd A high performance, embeddable MQTT broker crates.io page

Contents

Installation and Usage

rumqttd

Run using docker

rumqttd can be used with docker by pulling the image from docker hub as follows:

docker pull bytebeamio/rumqttd

To use the rumqttd docker image with the included rumqttd.toml while exposing the necessary ports for clients to interact with the broker, use the following command:

docker run -p 1883:1883 -p 1884:1884 -it bytebeamio/rumqttd -c rumqttd.toml

One can also mount the local directory containing configs as a volume and use the appropriate config file as follows:

docker run -v /path/to/configs:/configs -p 1883:1883 -it bytebeamio/rumqttd -c /configs/config.toml

Prebuilt binaries

For prebuilt binaries checkout our releases, download suitable binary for your system and move it to any directory in your PATH.


Install using cargo

cargo install --git https://github.com/bytebeamio/rumqtt rumqttd

download the demo config file

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/bytebeamio/rumqtt/main/rumqttd/rumqttd.toml > rumqttd.toml

and run the broker using

rumqttd --config rumqttd.toml

Note: Make sure to you correct rumqttd.toml file for a specific version of rumqttd


Compile from source

Clone the repo using git clone.

git clone --depth=1 https://github.com/bytebeamio/rumqtt/

Change directory to that folder and run

cd rumqtt
cargo run --release --bin rumqttd -- -c rumqttd/rumqttd.toml -vvv

for more information look at rumqttd's README

rumqttc

Add rumqttc to your project using

cargo add rumqttc --all-features

for more information look at rumqttc's README

Features

rumqttd

  • MQTT 3.1.1
  • QoS 0 and 1
  • Connection via TLS
  • Retransmission after reconnect
  • Last will
  • Retained messages
  • QoS 2
  • MQTT 5

rumqttc

  • MQTT 3.1.1
  • MQTT 5

Community

Contributing

Please follow the code of conduct while opening issues to report bugs or before you contribute fixes, also do read our contributor guide to get a better idea of what we'd appreciate and what we won't.

License

This project is released under The Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)