From 46c378d82ca0136b173fb7fdac5524441019a949 Mon Sep 17 00:00:00 2001 From: Robert Csakany Date: Fri, 10 Jul 2020 01:39:14 +0200 Subject: [PATCH] Updating zigbee2mqttassistant documentation --- docs/Zigbee2mqttassistant.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/Zigbee2mqttassistant.md diff --git a/docs/Zigbee2mqttassistant.md b/docs/Zigbee2mqttassistant.md new file mode 100644 index 00000000..f5f3d682 --- /dev/null +++ b/docs/Zigbee2mqttassistant.md @@ -0,0 +1,20 @@ +# Zigbee2Mqtt Assistant +## References +- [Docker](https://hub.docker.com/r/carldebilly/zigbee2mqttassistant) +- [Website](https://github.com/yllibed/Zigbee2MqttAssistant/blob/master/README.md) + +## About + +This service a web frontend which displays Zigbee2Mqtt service messages and able to control it over Mqtt. For the +servie a working Mqtt server is required and that have to be configured. + +## Environment Parameters + +Z2MA_SETTINGS__MQTTSERVER=mosquitto - The mqtt service instance which is used by Zigbee2Mqtt instance. +Z2MA_SETTINGS__MQTTUSERNAME= - When mqtt server have authentication this user is used. +Z2MA_SETTINGS__MQTTPASSWORD= - When mqtt server have authentication this user is used. +TZ=Europe/Budapest - Recommmended to setup for correct timestamps. + +## Accessing the UI +The Zigbee2Mqtt Assistant UI is available using port 8880 (http://your.local.ip.address:8880/) +