Signed-off-by: Srikanth Anantharam <sria91@gmail.com> |
8 years ago | |
---|---|---|
client | 8 years ago | |
doc | 8 years ago | |
docker | 9 years ago | |
examples | 11 years ago | |
installer | 8 years ago | |
lib | 8 years ago | |
logo | 9 years ago | |
man | 8 years ago | |
misc/currentcost | 10 years ago | |
security | 11 years ago | |
service | 11 years ago | |
snap | 9 years ago | |
src | 8 years ago | |
test | 8 years ago | |
.gitignore | 11 years ago | |
.travis.yml | 10 years ago | |
CMakeLists.txt | 8 years ago | |
CONTRIBUTING.md | 9 years ago | |
ChangeLog.txt | 8 years ago | |
LICENSE.txt | 12 years ago | |
Makefile | 9 years ago | |
Mosquitto.podspec | 9 years ago | |
THANKS.txt | 9 years ago | |
about.html | 12 years ago | |
aclfile.example | 12 years ago | |
appveyor.yml | 8 years ago | |
compiling.txt | 11 years ago | |
config.h | 9 years ago | |
config.mk | 8 years ago | |
edl-v10 | 12 years ago | |
epl-v10 | 12 years ago | |
mosquitto.conf | 8 years ago | |
notice.html | 12 years ago | |
pskfile.example | 12 years ago | |
pwfile.example | 12 years ago | |
readme-windows.txt | 9 years ago | |
readme.md | 9 years ago | |
set-version.sh | 8 years ago | |
travis-configure.sh | 9 years ago | |
travis-install.sh | 9 years ago |
readme.md
Eclipse Mosquitto
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.
Links
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/
Installing
See http://mosquitto.org/download/ for details on installing binaries for various platforms.
Quick start
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
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/
Building from source
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.
Build Dependencies
- 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
Credits
Mosquitto was written by Roger Light roger@atchoo.org