Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.03 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.03 KB
Raw

VolantMQ

Build Status BCH compliance Codacy Badge codecov.io License

VolantMQ is a high performance MQTT broker that aims to be fully compliant with MQTT specs

Features, Limitations, and Future

Features

  • MQTT v3.1 - V3.1.1
  • MQTT V5.0
  • WebSockets transport
  • SSL for both plain tcp and WebSockets transports
  • Independent auth providers for each transport
  • Persistence providers

Persistence providers

Compatibility

Project has been tested with the following client libraries

  • Paho MQTT Conformance/Interoperability Testing Suite (in Python)
    • Pass with all of the test cases
  • Paho C Client library (in C)
    • Pass with all of the test cases

How to use

Best option is to run prebuilt docker image

docker run --rm -p 1883:1883 -p 8080:8080 -v $(pwd)/examples/config.yaml:/etc/volantmq/config.yaml --env VOLANTMQ_CONFIG=/etc/volantmq/config.yaml volantmq/volantmq
  • In example above port 1883 is mqtt listener with default user/password testuser/testpassword
  • Port 8080 exposes healthcheck endpoints as well as pprof at http://localhost:8080/debug/pprof

Contributing guidelines