Connects Zigbee lights, sensors and switches to your smart home through a Zigbee coordinator, with no vendor hub or cloud
On this page
Good to know before you install
Needs a Zigbee coordinator on your network, such as an SLZB-06. Using a USB stick plugged into this server is coming soon.
At a glance#
- What it is
- Zigbee Bridge Smart Home
- Where it opens
- Web Interface
On its own port at
http://your-server:port, orzigbee.your-domainonce you have a domain - Updates
- Automatic A backup is taken first, and it rolls back if the update fails
- Backups
- Included Part of the daily backup when that's switched on
- Copies
- One per server
- Needs
- mosquitto
There's no step-by-step guide for Zigbee2MQTT here yet. Everything below comes straight from the app catalogue, so it's what LibrePortal really does when you install it. For using Zigbee2MQTT itself, its own documentation is the place to go: github.com/Koenkk/zigbee2mqtt.
Addresses and ports#
Zigbee2MQTT has one port. LibrePortal picks a free port number for each when you install, so yours will differ from anyone else's. The Config tab's Network section shows them, and the app's Open button uses the right one.
| What it is | Who can reach it | With a domain |
|---|---|---|
| Web Interface | Trusted places only | zigbee.your-domain |
Settings#
In its config file#
Zigbee2MQTT's own settings aren't on the Config tab yet. They live in the app's config file, described here so you know they exist. How to change them.
| Setting | What it does | Starts as |
|---|---|---|
NameCFG_ZIGBEE2MQTT_DISPLAY_NAME |
What this app is called on your dashboards. Leave empty to use its usual name | Empty |
Show on the LibrePortal DashboardCFG_ZIGBEE2MQTT_SHOW_ON_DASHBOARD |
Whether this app gets a shortcut on the front page of the LibrePortal WebUI, separate from any Dashy dashboard Choices: true, false |
true |
Firmware Update CheckCFG_ZIGBEE2MQTT_UPDATE_CHECK |
Whether Zigbee2MQTT may look up device firmware updates on GitHub by itself Choices: true, false |
false |
Detailed logsCFG_ZIGBEE2MQTT_VERBOSE_LOGS |
Whether Zigbee2MQTT writes its normal, chattier logs, including who connected, instead of only warnings and errors. Choices: true, false |
false |
Debug logging for 24 hoursCFG_ZIGBEE2MQTT_DEBUG_LOGS |
Turn on to see everything Zigbee2MQTT is doing while you look for a problem; it turns itself off after 24 hours. Choices: true, false |
false |
Tools#
Zigbee2MQTT's Tools tab has 1 button for jobs you'd otherwise need a terminal for. Each one runs as a task, so you can watch it on the Tasks page and read what it did. More about Tools.
The Zigbee coordinator Zigbee2MQTT uses. It starts once one is set.
Works with#
These are the other apps Zigbee2MQTT knows how to work with. Once it's installed, its page shows the same list with whether each one is connected. How this works.
- MQTT: Sends your Zigbee devices' messages through Mosquitto. LibrePortal sets this up by itself when both are installed.
- Grafana: Shows dashboards for the apps that have one. works with every app
- Home Assistant: Zigbee devices appear in Home Assistant by themselves.
- Prometheus: Collects metrics from the apps that can export them. works with every app
- Uptime Kuma: Watches your apps and shows when one goes down. works with every app
Privacy and security#
Worth knowing Zigbee2MQTT connects your Zigbee devices without a cloud. It goes online only to look for device firmware updates on GitHub.
What leaves this server#
- Firmware lists are fetched from GitHub when a device asks for an update, at most once a day
What LibrePortal turns off#
Nothing needed switching off.
Licence: GPL-3.0. Audited: 21 October 2026. See the privacy of every app and the Promise.
Sources#
Under the hood#
- It runs this image:
koenkk/zigbee2mqtt:2.14.2@sha256:addbfb08fcef2e4477de1535636118241e10d13e898fbe4d9faba8a4d7396311. - It can sit behind Authelia's sign-in once Authelia is installed.
- Its own project and documentation: github.com/Koenkk/zigbee2mqtt
Ports, settings, tools and connections on this page are read from LibrePortal v0.10.97's app catalogue each time the guide is built.