9 releases

0.1.0-alpha.10 Apr 15, 2020
0.1.0-alpha.8 Mar 29, 2020
0.1.0-alpha.5 Feb 16, 2020
0.1.0-alpha.3 Jan 6, 2020
0.1.0-alpha.2 Dec 26, 2019

#30 in #mqtt-client

Download history 33/week @ 2023-12-22 7/week @ 2023-12-29 19/week @ 2024-01-12 13/week @ 2024-01-19 32/week @ 2024-02-02 81/week @ 2024-02-09 79/week @ 2024-02-16 60/week @ 2024-02-23 56/week @ 2024-03-01 59/week @ 2024-03-08 41/week @ 2024-03-15 41/week @ 2024-03-22 89/week @ 2024-03-29 21/week @ 2024-04-05

205 downloads per month
Used in 4 crates (3 directly)

MIT license

81KB
2K SLoC

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 run rumqttd docker image you can simply run:

docker run -p 1883:1883 -p 1884:1884 -it bytebeamio/rumqttd

Or you can run rumqttd with the custom config file by mounting the file and passing it as argument:

docker run -p 1883:1883 -p 1884:1884 -v /absolute/path/to/rumqttd.toml:/rumqttd.toml -it rumqttd -c /rumqttd.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


Install using AUR

paru -S rumqttd-bin

replace paru with whatever AUR helper you are using.

Note: Configuration is found in /etc/rumqtt/config.toml and systemd service name rumqtt.service


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

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)

Dependencies

~5MB
~81K SLoC