Skip to content

Commit 46c378d

Browse files
committed
Updating zigbee2mqttassistant documentation
1 parent 3b3e76b commit 46c378d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/Zigbee2mqttassistant.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Zigbee2Mqtt Assistant
2+
## References
3+
- [Docker](https://hub.docker.com/r/carldebilly/zigbee2mqttassistant)
4+
- [Website](https://github.com/yllibed/Zigbee2MqttAssistant/blob/master/README.md)
5+
6+
## About
7+
8+
This service a web frontend which displays Zigbee2Mqtt service messages and able to control it over Mqtt. For the
9+
servie a working Mqtt server is required and that have to be configured.
10+
11+
## Environment Parameters
12+
13+
Z2MA_SETTINGS__MQTTSERVER=mosquitto - The mqtt service instance which is used by Zigbee2Mqtt instance.
14+
Z2MA_SETTINGS__MQTTUSERNAME=<optional> - When mqtt server have authentication this user is used.
15+
Z2MA_SETTINGS__MQTTPASSWORD=<optional> - When mqtt server have authentication this user is used.
16+
TZ=Europe/Budapest <optional> - Recommmended to setup for correct timestamps.
17+
18+
## Accessing the UI
19+
The Zigbee2Mqtt Assistant UI is available using port 8880 (http://your.local.ip.address:8880/)
20+

0 commit comments

Comments
 (0)