imagegenius/zigbee2mqtt

Zigbee2MQTT allows you to use your Zigbee devices without the vendor's bridge or gateway.

Supported Architectures

We use Docker manifest for cross-platform compatibility. More details can be found on Docker's website.

To obtain the appropriate image for your architecture, simply pull ghcr.io/imagegenius/zigbee2mqtt:latest. Alternatively, you can also obtain specific architecture images by using tags.

This image supports the following architectures:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	❌
armhf	❌

Application Setup

The default configuration should be enough to get started but you may need to change the USB device in /config/configuration.yaml

Usage

Example snippets to start creating a container:

Docker Compose

---
services:
  zigbee2mqtt:
    image: ghcr.io/imagegenius/zigbee2mqtt:latest
    container_name: zigbee2mqtt
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - path_to_appdata:/config
    ports:
      - 9442:9442
    devices:
      - /dev/ttyUSB0:/dev/ttyUSB0
    restart: unless-stopped

Docker CLI (Click here for more info)

docker run -d \
  --name=zigbee2mqtt \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 9442:9442 \
  -v path_to_appdata:/config \
  --device /dev/ttyUSB0:/dev/ttyUSB0 \
  --restart unless-stopped \
  ghcr.io/imagegenius/zigbee2mqtt:latest

Parameters

To configure the container, pass variables at runtime using the format <external>:<internal>. For instance, -p 8080:80 exposes port 80 inside the container, making it accessible outside the container via the host's IP on port 8080.

Parameter	Function
-p 9442	WebUI Port
-e PUID=1000	UID for permissions - see below for explanation
-e PGID=1000	GID for permissions - see below for explanation
-e TZ=Etc/UTC	Specify a timezone to use, see this list.
-v /config	Appdata Path
--device /dev/ttyUSB0	Path the the Zigbee USB, usually /dev/ttyUSB0 or /dev/ttyACM0

Umask for running applications

All of our images allow overriding the default umask setting for services started within the containers using the optional -e UMASK=022 option. Note that umask works differently than chmod and subtracts permissions based on its value, not adding. For more information, please refer to the Wikipedia article on umask here.

User / Group Identifiers

To avoid permissions issues when using volumes (-v flags) between the host OS and the container, you can specify the user (PUID) and group (PGID). Make sure that the volume directories on the host are owned by the same user you specify, and the issues will disappear.

Example: PUID=1000 and PGID=1000. To find your PUID and PGID, run id user.

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Updating the Container

Most of our images are static, versioned, and require an image update and container recreation to update the app. We do not recommend or support updating apps inside the container. Check the Application Setup section for recommendations for the specific image.

Instructions for updating containers:

Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull zigbee2mqtt
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d zigbee2mqtt
• You can also remove the old dangling images: docker image prune

Via Docker Run

• Update the image: docker pull ghcr.io/imagegenius/zigbee2mqtt:latest
• Stop the running container: docker stop zigbee2mqtt
• Delete the container: docker rm zigbee2mqtt
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

Versions

• 24.04.24: - rebase to alpine 3.19
• 02.01.23: - Initial Release.