Merge pull request #430 from danielwelch/doc_update

Added more specific update documentation
danielwelch · Oct 1, 2020 · 57f1374 · 57f1374
2 parents dd566cc + fb88288
commit 57f1374
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/zigbee2mqtt/CHANGELOG.md b/zigbee2mqtt/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## 1.15.0
 - Updated Zigbee2mqtt to version [`1.15.0`](https://github.com/Koenkk/zigbee2mqtt/releases/tag/1.15.0)
-- Added support for a [built-in frontend](https://github.com/Koenkk/zigbee2mqtt/issues/4266) using `ingress`
+- Added support for a [built-in frontend](https://github.com/Koenkk/zigbee2mqtt/issues/4266) using `ingress`. See Documentation tab for more details.
 
 ## 1.14.4.2
 - Added readme for Edge version

diff --git a/zigbee2mqtt/DOCS.md b/zigbee2mqtt/DOCS.md
@@ -4,6 +4,15 @@
 By default the add-on has `permit_join` set to `false`. To allow devices to join you need to activate this after the add-on has started. You can now use the [built-in frontend](https://www.zigbee2mqtt.io/information/frontend.html) to achieve this. For details on how to enable the built-in frontent see the next section.
 
 ### Enabling the built-in Frontend
+Make sure your add-on options have the right settings. If you already had experimental options, you might now automatically get `new_api` set properly on update.
+
+```yaml
+frontend:
+  port: 8099
+experimental:
+  new_api: true
+```
+
 Enable `ingress` to have the frontend available in your UI: **Supervisor → Dashboard → Zigbee2mqtt → Show in sidebar**. You can find more details about the feature on the [Zigbee2mqtt documentation](https://www.zigbee2mqtt.io/information/frontend.html).
 
 # Configuration