demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 23:22:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
d42efe0b22
openhab-addons/bundles/org.openhab.io.mqttembeddedbroker
History
Hilbrand Bouwkamp 003c3af985
Remove immediate = true from all Components (#8615) 
We recommend not to use this on add-ons.

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2020-10-01 20:27:01 -07:00
..
src Remove immediate = true from all Components (#8615) 2020-10-01 20:27:01 -07:00
NOTICE added migrated 2.x add-ons 2020-09-21 03:37:19 +02:00
pom.xml Fix parallel MQTT itests execution (#8617) 2020-09-30 19:36:47 +02:00
README.md added migrated 2.x add-ons 2020-09-21 03:37:19 +02:00

README.md

MQTT Broker Moquette

Attention: Moquette is no longer maintained upstream and this add-on is therefore considered deprecated in openHAB. It is recommended to switch to an external broker like mosquitto. The Moquette add-on will be removed in a future release of openHAB.

MQTT is a machine-to-machine (M2M)/"Internet of Things" connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging transport.

To allow MQTT capable devices to communicate with each other you need a software called MQTT Broker.

You can either install one of the many MQTT Broker offerings like the free Mosquitto broker or use this pre-configured Moquette broker.

Check your Inbox after installation.

Service Configuration

All parameters are optional and can be set by file or the REST interface (user-interfaces).

  • port: The port, the embedded broker should run on. Defaults to not set, which means the typical ports 1883 and 8883 (SSL) are used.
  • username: The user name that clients need to provide to connect to this broker.
  • password: The password that clients need to provide to connect to this broker.
  • secure: If set, hosts a secure SSL connection on port 8883 or otherwise a non secure connection on port 1883 (if not overwritten by the port parameter).
  • persistence_file: An optional persistence file. Retained messages are stored in this file. Can be empty to not store anything. The default is "userdata/mqttembedded.bin". If it starts with "/" on Linux/macOS or with a drive letter and colon (eg "c:/") it will be treated as an absolute path. Be careful to select a path that you have write access to.

TLS connections

The keystore that is included to allow to start a TLS encrypted connection is generated by:

keytool -genkey -v -keystore serverkeystore.keystore -alias main -keyalg RSA -keysize 2048 -validity 100000 -deststoretype pkcs12

The keystore is embedded into the bundle and cannot be replaced.

Plans for the future

  • The moquette MQTT broker supports ACL (access control lists), so allows to restrict read/write access per topic per user or client id. That need to be exposed as configuration values at some point.

  • Multiple users are supported by the broker software. openHAB does not yet have a user management though.

  • The keystore need to be replaceable as soon as openHAB gained a way to configure SSL truststores framework wide.