MQTT User Config

XcOM9876 · March 2, 2021, 9:14pm

So I am following the instructions to install the MQTT broker from the addon repo, it mentions to create a user, I’ve looked and I can’t see the option to add one, I’ve also had a google around and all the answers say to enable Advanced view which I’ve had enabled for a while, I turned it off and back on again to make sure there wasn’t something funky, I can confirm advanced options are visible elsewhere

core-2021.2.3
supervisor-2021.02.11
Home Assistant OS 5.12
MQTT 5.1.1

tteck · March 2, 2021, 9:29pm

github.com

home-assistant/addons/blob/ad4dea47d8f793ad762420d13a3995f070f0df6e/mosquitto/DOCS.md

# Home Assistant Add-on: Mosquitto broker

## Installation

Follow these steps to get the add-on installed on your system:

1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
2. Find the "Mosquitto broker" add-on and click it.
3. Click on the "INSTALL" button.

## How to use

The add-on has a couple of options available. To get the add-on running:

1. Start the add-on.
2. Have some patience and wait a couple of minutes.
3. Check the add-on log output to see the result.

Create a new user for MQTT via the **Configuration** -> **Users (manage users)**.
Notes:

This file has been truncated. show original

I use the Old school method

logins:
  - username: user
    password: passwd

123 · March 2, 2021, 9:45pm

It indicates to enable Advanced Mode so that Configuration > Users becomes visible. Normally this menu option is hidden.

Use Configuration > Users to create a user account. This account can access several things (aside from Home Assistant itself) including the MQTT broker (Mosquitto Add-on). That’s what I did when I needed an account to login to the broker using an external MQTT client (MQTT Explorer).

XcOM9876 · March 3, 2021, 8:22am

Advanced mode is enabled yet the user option is still not visible:

When I check the logs it’s showing that it can’t find a user yet it’s working

XcOM9876 · March 3, 2021, 8:27am

I tried this config as per the GITHUB but it throws an error about the YAML being invalid:

AdmiralStipe · March 3, 2021, 8:36am

I would say, you have to loose the first line (logins: []) in your config, as now you have logins defined twice. So if you delete the first line, the actual logins defined lower down will take effect.

XcOM9876 · March 3, 2021, 8:51am

How I didn’t spot that I don’t know lol, fresh eyes and all that jazz lol,

I assume this is all good according to the logs

aidand · July 6, 2021, 4:43am

For those finding this like I have and failed to understand the instuctions at first glance. The instruction is to create a new user within Home Assistant, not Mosquitto itself. It can be a little confusing seeing “configuration → users” when there is a configuration page for Mosquitto. This new user will be used by misquitto (and by extention MQTT devices).

123 · July 6, 2021, 4:48am

I thought this was fairly straightforward when I wrote it last March:

clemo · November 19, 2021, 11:16am

I confirm it is confusing. Went through the same thing as Aidan to finally end up here. Why don’t you change the help text to something like this?

Create a new user for MQTT via Home Assistant’s (not Mosquitto’s configuration tab) Configuration → Users (manage users). Notes:

This name cannot be homeassistant or addon, those are reserved usernames.
If Home Assistant does not show the option to create a new user, ensure that Advanced Mode is enabled in your Home Assistant profile.

123 · November 19, 2021, 5:40pm

Everyone has the opportunity to modify the documentation. This post explains how:

clemo · November 22, 2021, 7:29am

Didn’t know that, thanks for the suggestion. I filed a pull request.

dbrunt · May 4, 2022, 12:40am

I have posted a question that is related to MQTT User Config over in this topic.
Hoping someone can help answer it…

jrbenHA · October 23, 2024, 2:29pm

HA reminds me of the old TECO editor on DEC PDP11 machines. To comprehend the docs you needed to first figure out how TECO worked.