Mosquitto broker for Home Assistant (app)

About

Mosquitto broker is an app that runs an open source MQTT broker inside Home Assistant. It runs on Home Assistant OS and supports aarch64 and amd64 systems. The broker can check Home Assistant usernames and passwords, so separate local users are optional, though local users can be defined with a plain or pre-hashed password. Anonymous connections are not supported, so every client must sign in with a username and password. Options cover logging destinations and log types, extra configuration files read from a chosen folder, and certificate files for encrypted connections on separate ports. It has no page of its own in the sidebar, and Home Assistant picks it up as a discovered MQTT integration.

Automatic summary of the docs and configuration of home-assistant/apps. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Updated with Home Assistant Ships and updates with every Home Assistant release.

Setting it up

Install it under Settings, Apps, then start it.

Permissions

Sign-in checksCan check Home Assistant usernames and passwords.

Network

1883/tcpNormal MQTT
1884/tcpMQTT over WebSocket
8883/tcpNormal MQTT with SSL
8884/tcpMQTT over WebSocket with SSL

Configuration

LoginsA list of local users that will be created with username and password. You don't need to do this because you can use Home Assistant users too, without any configuration. You can also specify password_pre_hashed: true to utilize a pre-hashed password from the output of the pw command (which is present inside the container).
Log DestinationsOptional list of Mosquitto log destinations. Allowed values are none, stdout, stderr and topic. If empty, defaults to stdout.
Log TypesOptional list of Mosquitto log types. If empty, defaults to error, warning, notice, and information. Ignored and defaults to all when Debug is enabled.
Require Client CertificateIf enabled client will need to provide its own certificate on top of username/password. 'cafile' must be set.
Certificate FileA file containing a certificate, including its chain. Place this file in the Home Assistant ssl folder.
CA FileA file containing a root certificate that signed the client certificate (only used if 'require_certificate' enabled). Place this file in the Home Assistant ssl folder.
Private Key FileA file containing the private key. Place this file in the Home Assistant ssl folder.
CustomizeSee the Documentation tab for more information about these options.
DebugIf enabled will turn on debug logging for mosquitto and the auth plugin.