2020-01-22 22:31:05 +00:00
---
2020-11-29 22:25:02 +00:00
title: zigbee2mqtt_docker
2020-01-22 22:31:05 +00:00
type: docs
---
2020-06-04 13:22:09 +00:00
[![Source Code ](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white )](https://gitea.rknet.org/ansible/xoxys.zigbee2mqtt) [![Build Status ](https://img.shields.io/drone/build/ansible/xoxys.zigbee2mqtt?logo=drone&server=https%3A%2F%2Fdrone.rknet.org )](https://drone.rknet.org/ansible/xoxys.zigbee2mqtt) [![License: MIT ](https://img.shields.io/badge/license-MIT-blue.svg )](https://gitea.rknet.org/ansible/xoxys.zigbee2mqtt/src/branch/master/LICENSE)
2020-01-31 10:35:08 +00:00
Setup [zigbee2mqtt ](https://github.com/Koenkk/zigbee2mqtt ). Zigbee2mqtt allows you to use your Zigbee devices without the vendors bridge or gateway. It bridges events and allows you to control your Zigbee devices via MQTT.
2020-01-22 22:31:05 +00:00
* [Default Variables ](#default-variables )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_cache_state ](#zigbee2mqtt_cache_state )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_cap_add ](#zigbee2mqtt_cap_add )
* [zigbee2mqtt_cap_drop ](#zigbee2mqtt_cap_drop )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_channel ](#zigbee2mqtt_channel )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_container_name ](#zigbee2mqtt_container_name )
* [zigbee2mqtt_cpu_shares ](#zigbee2mqtt_cpu_shares )
* [zigbee2mqtt_data_volume ](#zigbee2mqtt_data_volume )
* [zigbee2mqtt_devices ](#zigbee2mqtt_devices )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_devices_ban ](#zigbee2mqtt_devices_ban )
* [zigbee2mqtt_devices_whitelist ](#zigbee2mqtt_devices_whitelist )
* [zigbee2mqtt_elapsed ](#zigbee2mqtt_elapsed )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_exposed_ports ](#zigbee2mqtt_exposed_ports )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_ext_pan_id ](#zigbee2mqtt_ext_pan_id )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_extra_hosts ](#zigbee2mqtt_extra_hosts )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_homeassistant_discovery_topic ](#zigbee2mqtt_homeassistant_discovery_topic )
* [zigbee2mqtt_homeassistant_enabled ](#zigbee2mqtt_homeassistant_enabled )
* [zigbee2mqtt_homeassistant_status_topic ](#zigbee2mqtt_homeassistant_status_topic )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_image ](#zigbee2mqtt_image )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_last_seen ](#zigbee2mqtt_last_seen )
* [zigbee2mqtt_log_level ](#zigbee2mqtt_log_level )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_memory_limit ](#zigbee2mqtt_memory_limit )
* [zigbee2mqtt_memory_reservation ](#zigbee2mqtt_memory_reservation )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_mqtt_base_topic ](#zigbee2mqtt_mqtt_base_topic )
* [zigbee2mqtt_mqtt_client_id ](#zigbee2mqtt_mqtt_client_id )
* [zigbee2mqtt_mqtt_include_device_information ](#zigbee2mqtt_mqtt_include_device_information )
* [zigbee2mqtt_mqtt_password ](#zigbee2mqtt_mqtt_password )
* [zigbee2mqtt_mqtt_reject_unauthorized ](#zigbee2mqtt_mqtt_reject_unauthorized )
* [zigbee2mqtt_mqtt_server ](#zigbee2mqtt_mqtt_server )
* [zigbee2mqtt_mqtt_user ](#zigbee2mqtt_mqtt_user )
* [zigbee2mqtt_network_key ](#zigbee2mqtt_network_key )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_networks ](#zigbee2mqtt_networks )
* [zigbee2mqtt_networks_applied ](#zigbee2mqtt_networks_applied )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_pan_id ](#zigbee2mqtt_pan_id )
* [zigbee2mqtt_permit_join ](#zigbee2mqtt_permit_join )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_pids_limit ](#zigbee2mqtt_pids_limit )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_report_enabled ](#zigbee2mqtt_report_enabled )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_restart_policy ](#zigbee2mqtt_restart_policy )
* [zigbee2mqtt_security_opt ](#zigbee2mqtt_security_opt )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_serial_disable_led ](#zigbee2mqtt_serial_disable_led )
* [zigbee2mqtt_serial_port ](#zigbee2mqtt_serial_port )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_service_directory ](#zigbee2mqtt_service_directory )
* [zigbee2mqtt_service_stopped ](#zigbee2mqtt_service_stopped )
* [zigbee2mqtt_timezone ](#zigbee2mqtt_timezone )
2020-05-25 21:09:58 +00:00
* [zigbee2mqtt_version ](#zigbee2mqtt_version )
2020-11-29 22:25:02 +00:00
* [zigbee2mqtt_volumes ](#zigbee2mqtt_volumes )
2020-01-22 22:31:05 +00:00
* [Dependencies ](#dependencies )
---
## Default Variables
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_cache_state
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_cache_state: true
2020-01-22 22:31:05 +00:00
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_cap_add
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_cap_add: []
```
### zigbee2mqtt_cap_drop
#### Default value
```YAML
zigbee2mqtt_cap_drop: []
2020-01-22 22:31:05 +00:00
```
### zigbee2mqtt_channel
#### Default value
```YAML
zigbee2mqtt_channel: 11
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_container_name
#### Default value
```YAML
zigbee2mqtt_container_name: zigbee2mqtt
```
### zigbee2mqtt_cpu_shares
#### Default value
```YAML
zigbee2mqtt_cpu_shares: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_cpu_shares: '1024'
```
### zigbee2mqtt_data_volume
#### Default value
```YAML
zigbee2mqtt_data_volume: /opt/zigbee2mqtt/data
```
### zigbee2mqtt_devices
Define required devices e.g. `/dev/ttyACM0` .
#### Example usage
```YAML
zigbee2mqtt_devices:
- src: "{{ zigbee2mqtt_serial_port }}"
dest: "{{ zigbee2mqtt_serial_port }}"
opt: z
```
2020-01-22 22:31:05 +00:00
### zigbee2mqtt_devices_ban
#### Default value
```YAML
zigbee2mqtt_devices_ban: []
```
### zigbee2mqtt_devices_whitelist
#### Default value
```YAML
zigbee2mqtt_devices_whitelist: []
```
### zigbee2mqtt_elapsed
#### Default value
```YAML
zigbee2mqtt_elapsed: false
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_exposed_ports
#### Default value
```YAML
zigbee2mqtt_exposed_ports: []
```
2020-01-22 22:31:05 +00:00
### zigbee2mqtt_ext_pan_id
#### Default value
```YAML
zigbee2mqtt_ext_pan_id: '[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]'
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_extra_hosts
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_extra_hosts: []
2020-01-22 22:31:05 +00:00
```
### zigbee2mqtt_homeassistant_discovery_topic
#### Default value
```YAML
zigbee2mqtt_homeassistant_discovery_topic: homeassistant
```
### zigbee2mqtt_homeassistant_enabled
#### Default value
```YAML
zigbee2mqtt_homeassistant_enabled: false
```
### zigbee2mqtt_homeassistant_status_topic
#### Default value
```YAML
zigbee2mqtt_homeassistant_status_topic: hass/status
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_image
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_image: koenkk/zigbee2mqtt:{{ zigbee2mqtt_version }}
2020-01-22 22:31:05 +00:00
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_last_seen
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_last_seen: disable
2020-01-22 22:31:05 +00:00
```
### zigbee2mqtt_log_level
#### Default value
```YAML
zigbee2mqtt_log_level: info
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_memory_limit
#### Default value
```YAML
zigbee2mqtt_memory_limit: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_memory_limit: 512m
```
### zigbee2mqtt_memory_reservation
#### Default value
```YAML
zigbee2mqtt_memory_reservation: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_memory_reservation: 256m
```
2020-01-22 22:31:05 +00:00
### zigbee2mqtt_mqtt_base_topic
#### Default value
```YAML
zigbee2mqtt_mqtt_base_topic: zigbee2mqtt
```
### zigbee2mqtt_mqtt_client_id
#### Default value
```YAML
zigbee2mqtt_mqtt_client_id: zigbee2mqtt
```
### zigbee2mqtt_mqtt_include_device_information
#### Default value
```YAML
zigbee2mqtt_mqtt_include_device_information: false
```
### zigbee2mqtt_mqtt_password
#### Default value
```YAML
zigbee2mqtt_mqtt_password: _unset_
```
### zigbee2mqtt_mqtt_reject_unauthorized
#### Default value
```YAML
zigbee2mqtt_mqtt_reject_unauthorized: false
```
### zigbee2mqtt_mqtt_server
#### Default value
```YAML
zigbee2mqtt_mqtt_server: mqtt://localhost:1883
```
### zigbee2mqtt_mqtt_user
#### Default value
```YAML
zigbee2mqtt_mqtt_user: _unset_
```
### zigbee2mqtt_network_key
#### Default value
```YAML
zigbee2mqtt_network_key: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_network_key: '[1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]'
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_networks
#### Default value
```YAML
zigbee2mqtt_networks:
- name: default
```
#### Example usage
```YAML
zigbee2mqtt_networks:
- name: default
# optional network driver, defaults to 'bride'
driver: host
2021-03-14 15:22:22 +00:00
external: false
2020-11-29 22:25:02 +00:00
```
### zigbee2mqtt_networks_applied
#### Default value
```YAML
zigbee2mqtt_networks_applied:
- default
```
2020-01-22 22:31:05 +00:00
### zigbee2mqtt_pan_id
#### Default value
```YAML
zigbee2mqtt_pan_id: '0x1a62'
```
### zigbee2mqtt_permit_join
#### Default value
```YAML
zigbee2mqtt_permit_join: true
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_pids_limit
#### Default value
```YAML
zigbee2mqtt_pids_limit: _unset_
```
2020-01-22 22:31:05 +00:00
### zigbee2mqtt_report_enabled
#### Default value
```YAML
zigbee2mqtt_report_enabled: false
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_restart_policy
#### Default value
```YAML
zigbee2mqtt_restart_policy: always
```
### zigbee2mqtt_security_opt
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_security_opt: []
2020-01-22 22:31:05 +00:00
```
### zigbee2mqtt_serial_disable_led
#### Default value
```YAML
zigbee2mqtt_serial_disable_led: false
```
### zigbee2mqtt_serial_port
#### Default value
```YAML
zigbee2mqtt_serial_port: _unset_
```
#### Example usage
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_serial_port: ''
2020-01-22 22:31:05 +00:00
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_service_directory
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_service_directory: /var/lib/docker/services/zigbee2mqtt
2020-01-22 22:31:05 +00:00
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_service_stopped
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_service_stopped: false
2020-01-22 22:31:05 +00:00
```
2020-11-29 22:25:02 +00:00
### zigbee2mqtt_timezone
2020-01-22 22:31:05 +00:00
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_timezone: Europe/Berlin
2020-01-22 22:31:05 +00:00
```
### zigbee2mqtt_version
#### Default value
```YAML
2020-11-29 22:25:02 +00:00
zigbee2mqtt_version: latest
```
### zigbee2mqtt_volumes
Define required docker volumes.
#### Default value
```YAML
zigbee2mqtt_volumes:
- name: '{{ zigbee2mqtt_data_volume }}'
dest: /app/data
bind: true
```
#### Example usage
```YAML
zigbee2mqtt_volumes:
# Instead of the name you could specify a path on the container host system,
# but you also have to enable bind mount for this volume
- name: data
# target location inside the container
dest: /var/www/app/data
# enable bind mount, if false volume will be configured as named volume
# keep in mind you MUST set bind in any case
bind: True
# Options for bind mounts
bind_opt: "ro,z"
2020-01-22 22:31:05 +00:00
```
## Dependencies
None.