diff --git a/.templates/zigbee2mqttassistant/service.yml b/.templates/zigbee2mqttassistant/service.yml new file mode 100755 index 00000000..75c5f595 --- /dev/null +++ b/.templates/zigbee2mqttassistant/service.yml @@ -0,0 +1,11 @@ + zigbee2mqttassistant: + container_name: zigbee2mqttassistant + image: carldebilly/zigbee2mqttassistant + restart: unless-stopped + env_file: + - ./services/zigbee2mqttassistant/zigbee2mqttassistant.env + ports: + - 8880:80 + environment: + - VIRTUAL_HOST=~^zigbee2mqttassistant\..*\.xip\.io + - VIRTUAL_PORT=8880 diff --git a/.templates/zigbee2mqttassistant/zigbee2mqttassistant.env b/.templates/zigbee2mqttassistant/zigbee2mqttassistant.env new file mode 100755 index 00000000..0ce939db --- /dev/null +++ b/.templates/zigbee2mqttassistant/zigbee2mqttassistant.env @@ -0,0 +1,4 @@ +#TZ=Europe/Budapest \ +Z2MA_SETTINGS__MQTTSERVER=mosquitto +#Z2MA_SETTINGS__MQTTUSERNAME= +#Z2MA_SETTINGS__MQTTPASSWORD= 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/) + diff --git a/menu.sh b/menu.sh index a0a08b60..031e89de 100755 --- a/menu.sh +++ b/menu.sh @@ -44,6 +44,7 @@ declare -A cont_array=( [diyhue]="diyHue" [homebridge]="Homebridge" [python]="Python 3" + [zigbee2mqttassistant]="zigbee2mqttassistant" [gitea]="Gitea" [dozzle]="Dozzle" ) @@ -62,7 +63,7 @@ declare -a armhf_keys=( "adminer" "openhab" "zigbee2mqtt" - "deconz" + "deconz" "pihole" "plex" "tasmoadmin" @@ -75,6 +76,7 @@ declare -a armhf_keys=( "diyhue" "homebridge" "python" + "zigbee2mqttassistant" "gitea" "dozzle" # add yours here