Skip to content

Commit

Permalink
Updating zigbee2mqttassistant documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robertcsakany committed Jul 9, 2020
1 parent 3b3e76b commit 46c378d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Zigbee2mqttassistant.md
Original file line number Diff line number Diff line change
@@ -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=<optional> - When mqtt server have authentication this user is used.
Z2MA_SETTINGS__MQTTPASSWORD=<optional> - When mqtt server have authentication this user is used.
TZ=Europe/Budapest <optional> - Recommmended to setup for correct timestamps.

## Accessing the UI
The Zigbee2Mqtt Assistant UI is available using port 8880 (http://your.local.ip.address:8880/)

0 comments on commit 46c378d

Please sign in to comment.