diff options
Diffstat (limited to 'deps/rabbitmq_mqtt/README.md')
-rw-r--r-- | deps/rabbitmq_mqtt/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/deps/rabbitmq_mqtt/README.md b/deps/rabbitmq_mqtt/README.md new file mode 100644 index 0000000000..f0ba5d6b03 --- /dev/null +++ b/deps/rabbitmq_mqtt/README.md @@ -0,0 +1,38 @@ +# 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-2020 VMware, Inc. or its affiliates. + +Released under the [Mozilla Public License](https://www.rabbitmq.com/mpl.html), +the same as RabbitMQ. |