forked from gcgarner/IOTstack
-
Notifications
You must be signed in to change notification settings - Fork 308
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating zigbee2mqttassistant documentation
- Loading branch information
1 parent
3b3e76b
commit 46c378d
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) | ||
|