summaryrefslogtreecommitdiff
path: root/deps/rabbitmq_mqtt/README.md
blob: f0ba5d6b0382980cfbee479292a0d3a4c0b107c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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.