Updated mosquitto ACL docs with note about homeassistant user (home-a…

…ssistant#2421) * Updated mosquitto ACL docs with note about homeassistant user * Update mosquitto/DOCS.md Co-authored-by: Mike Degatano <[email protected]> Co-authored-by: Mike Degatano <[email protected]>
arcotek-ltd · Apr 28, 2022 · f899885 · f899885
1 parent 3d7bc63
commit f899885
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/mosquitto/DOCS.md b/mosquitto/DOCS.md
@@ -97,7 +97,9 @@ See the following links for more information:
 - [Mosquitto topic restrictions](http://www.steves-internet-guide.com/topic-restriction-mosquitto-configuration/)
 - [Mosquitto.conf man page](https://mosquitto.org/man/mosquitto-conf-5.html)
 
-Add the following configuration to enable **unrestricted** access to all topics.
+Add the following configuration to enable **unrestricted** access to all topics for `[YOUR_MQTT_USER]`.
+
+**Note:** Home Assistant expects the users `homeassistant` and `addons` to have unrestricted readwrite access to all topics. If you choose to enable ACLs, you should grant this access to these users as demonstrated below. Otherwise you will run into issues.
 
 1. Enable the customize flag
 
@@ -116,6 +118,12 @@ Add the following configuration to enable **unrestricted** access to all topics.
 3. Create `/share/mosquitto/accesscontrollist` with the contents:
 
     ```text
+    user addons
+    topic readwrite #
+    
+    user homeassistant
+    topic readwrite #
+    
     user [YOUR_MQTT_USER]
     topic readwrite #
     ```