mirror of https://github.com/eclipse-mosquitto/mosquitto.git synced 2026-04-12 16:25:02 +02:00

Mirror of https://github.com/eclipse-mosquitto/mosquitto.git

broker eclipse-iot libwebsockets mosquitto mqtt

Go to file

Roger A. Light 0296bd2e55 Update example Docker ports. Port 9001 is used by Intel drivers on Windows, so some users are suddenly seeing a problem. Issue #1580.		2020-04-23 13:10:11 +01:00
.github	Updated pull rqeuest text.	2020-03-19 15:45:18 +00:00
client	Update changelog. Release page. Bump copyright.	2020-02-27 23:26:58 +00:00
doc
docker	Update example Docker ports.	2020-04-23 13:10:11 +01:00
examples
installer	Update version.	2020-02-27 23:27:29 +00:00
lib	Update version.	2020-02-27 23:27:29 +00:00
logo
man
misc/currentcost
security
service
snap	Update version.	2020-02-27 23:27:29 +00:00
src	Update changelog. Release page. Bump copyright.	2020-02-27 23:26:58 +00:00
test
www	Update changelog. Release page. Bump copyright.	2020-02-27 23:26:58 +00:00
.gitignore
.travis.yml
about.html
aclfile.example
appveyor.yml
buildtest.py
ChangeLog.txt	Update changelog. Release page. Bump copyright.	2020-02-27 23:26:58 +00:00
CMakeLists.txt	Update version.	2020-02-27 23:27:29 +00:00
compiling.txt
config.h
config.mk	Update version.	2020-02-27 23:27:29 +00:00
CONTRIBUTING.md
edl-v10
epl-v10
libmosquitto.pc.in
libmosquittopp.pc.in
LICENSE.txt
Makefile
mosquitto.conf
Mosquitto.podspec
notice.html
pskfile.example
pwfile.example
readme-tests.md
readme-windows.txt
readme.md
SECURITY.md
set-version.sh	Update version.	2020-02-27 23:27:29 +00:00
THANKS.txt
travis-configure.sh
travis-install.sh

readme.md

Eclipse Mosquitto

Mosquitto is an open source implementation of a server for version 5.0, 3.1.1, and 3.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.

Installing

See https://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 https://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 https://mosquitto.org/api/

Building from source

To build from source the recommended route for end users is to download the archive from https://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.txt.

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) - only when compiled with make WITH_SRV=yes
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
uthash / utlist - bundled versions of these headers are provided, disable their use with make WITH_BUNDLED_DEPS=no

Equivalent options for enabling/disabling features are available when using the CMake build.

Credits

Mosquitto was written by Roger Light roger@atchoo.org

Master: Develop: Fixes: