This fork of Eclipse Mosquitto is maintained as a mirror of the upstream project to document our actual usage.
This code has been modified by TIBCO for use in its MQTT applications.
Any modifications different from the upstream should be considered temporary, as they will be submitted as pull requests to the upstream project. A process that generally involves subsequent modifications to the original request to make it more usable by a broader audience.
Eclipse Mosquitto users are encouraged to work directly with the primary project : Eclipse Mosquitto
In addition to the standard upstream branches, this repo contains a tibco-release branch maintained to document TIBCO releases.
Mosquitto is an open source implementation of a server for version 3.1 and
3.1.1 of the MQTT protocol. It also includes a C and C++ client library, and
the mosquitto_pub
and mosquitto_sub
utilities for publishing and
subscribing.
See the following links for more information on MQTT:
- Community page: http://mqtt.org/
- MQTT v3.1.1 standard: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html
Mosquitto project information is available at the following locations:
- Main homepage: http://mosquitto.org/
- Find existing bugs or submit a new bug: https://github.com/eclipse/mosquitto/issues
- Source code repository: https://github.com/eclipse/mosquitto
There is also a public test server available at http://test.mosquitto.org/
See http://mosquitto.org/download/ for details on installing binaries for various platforms.
If you have installed a binary package the broker should have been started automatically. If not, it can be started with a basic configuration:
mosquitto
Then use mosquitto_sub
to subscribe to a topic:
mosquitto_sub -t 'test/topic' -v
And to publish a message:
mosquitto_pub -t 'test/topic' -m 'hello world'
Documentation for the broker, clients and client library API can be found in
the man pages, which are available online at http://mosquitto.org/man/. There
are also pages with an introduction to the features of MQTT, the
mosquitto_passwd
utility for dealing with username/passwords, and a
description of the configuration file options available for the broker.
Detailed client library API documentation can be found at http://mosquitto.org/api/
To build from source the recommended route for end users is to download the archive from http://mosquitto.org/download/.
On Windows and Mac, use cmake
to build. On other platforms, just run make
to build. For Windows, see also readme-windows.md
.
If you are building from the git repository then the documentation will not
already be built. Use make binary
to skip building the man pages, or install
docbook-xsl
on Debian/Ubuntu systems.
- c-ares (libc-ares-dev on Debian based systems) - disable with
make WITH_SRV=no
- libuuid (uuid-dev) - disable with
make WITH_UUID=no
- libwebsockets (libwebsockets-dev) - enable with
make WITH_WEBSOCKETS=yes
- openssl (libssl-dev on Debian based systems) - disable with
make WITH_TLS=no
- xsltproc (xsltproc and docbook-xsl on Debian based systems) - only needed when building from git sources - disable with
make WITH_DOCS=no
Mosquitto was written by Roger Light roger@atchoo.org