rabbitmq-server/deps/rabbitmq_mqtt/README.md

39 lines
1.1 KiB
Markdown

# RabbitMQ MQTT Plugin
## Getting Started
This is an MQTT plugin for RabbitMQ.
The plugin is included in the RabbitMQ distribution. To enable
it, use [rabbitmq-plugins](https://www.rabbitmq.com/man/rabbitmq-plugins.1.man.html):
rabbitmq-plugins enable rabbitmq_mqtt
Default port used by the plugin is `1883`.
## Documentation
[MQTT plugin documentation](https://www.rabbitmq.com/mqtt.html) is available
from rabbitmq.com.
## Contributing
See [CONTRIBUTING.md](https://github.com/rabbitmq/rabbitmq-mqtt/blob/master/CONTRIBUTING.md).
### Running Tests
After cloning RabbitMQ umbrella repository, change into the `rabbitmq-mqtt` directory
and run
make tests
This will bring up a RabbitMQ node with the plugin enabled and run integration tests
against it. Note that there must be no other MQTT server running on ports `1883` and `8883`.
## Copyright and License
(c) 2007-2024 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
Released under the [Mozilla Public License](https://www.rabbitmq.com/mpl.html),
the same as RabbitMQ.