Integrating Homebridge, Mosquitto and Zigbee2mqtt on Raspberry Pi with Docker Compose

🌐 Overview

This docker-compose.yml file outlines a multi-container configuration for a home automation system, incorporating Homebridge, Mosquitto, and Zigbee2MQTT. It encompasses essential configurations for each service, including volumes, devices, and environment variables.

This setup serves to seamlessly integrate diverse smart home devices, encompassing lights, sensors, and switches, into the home automation framework. Inter-service communication occurs over the local network through MQTT and Zigbee protocols. The host machine for container execution is a RaspberryPi. Conbee II is the Zigbee USB dongle used for Zigbee device communication.

📝 Configuration

docker-compose.yml

services:
  homebridge:
    image: homebridge/homebridge:latest
    restart: always
    network_mode: host
    hostname: homebridge
    container_name: homebridge
    volumes:
      - ./homebridge:/homebridge
    devices:
      - /dev/ttyACM0:/dev/ttyACM0
    logging:
      driver: json-file
      options:
        max-size: "10mb"
        max-file: "1"
    healthcheck:
      test: curl --fail localhost:8581 || exit 1
      interval: 60s
      retries: 5
      start_period: 300s
      timeout: 2s
 
  mosquitto:
    image: eclipse-mosquitto
    restart: unless-stopped
    hostname: mosquitto
    container_name: mosquitto
    ports:
      - 1883:1883
      - 9001:9001
    volumes:
      - ./mosquitto:/mosquitto
    command: "mosquitto -c /mosquitto-no-auth.conf"
 
  zigbee2mqtt:
    image: koenkk/zigbee2mqtt:latest
    restart: unless-stopped
    network_mode: host
    hostname: zigbee2mqtt
    container_name: zigbee2mqtt
    volumes:
      - ./zigbee2mqtt:/app/data
      - /run/udev:/run/udev:ro
    environment:
      - TZ=Europe/Berlin
    devices:
      - /dev/ttyACM0:/dev/ttyACM0

💁🏼‍♀️ Services

🏠 Homebridge

The homebridge service runs the Homebridge server, which acts as a bridge between smart home devices and Apple’s HomeKit. It allows non-HomeKit compatible devices to be controlled via the Home app on iOS devices.

• image: Specifies the Docker image to use for the Homebridge service. In this case, it uses the latest version of the official Homebridge image.
• restart: Specifies the restart policy for the container. The always option ensures that the container restarts automatically if it stops.
• network_mode: Sets the network mode for the container to host, allowing the container to use the host network stack.
• hostname: Defines the hostname for the container.
• container_name: Specifies the name of the container.
• volumes: Maps a local directory (./homebridge) to the /homebridge directory in the container. This volume is used to persist Homebridge configuration and data.
• devices: Binds the host device /dev/ttyACM0 to the container device /dev/ttyACM0. This is used to communicate with USB devices connected to the host machine.
• logging: Configures the logging driver for the container to write logs to a JSON file.
  • driver: Specifies the logging driver to use.
  • options: Specifies additional options for the logging driver, such as the maximum log file size and the number of log files to keep.
    • max-size: Limits the size of each log file to 10 MB.
    • max-file: Specifies that only one log file should be kept.
• healthcheck: Defines a health check for the homebridge container to monitor its availability.
  • test: Runs a command (curl --fail localhost:8581 || exit 1) to check if the service is responding.
  • interval: Specifies how frequently the health check should run (every 60 seconds).
  • retries: Defines the number of failed attempts before considering the service unhealthy (5 retries).
  • start_period: Allows the service 300 seconds to start before running health checks.
  • timeout: Sets a timeout of 2 seconds for the health check command.

🔌 Mosquitto

The mosquitto service runs the Mosquitto MQTT broker, which facilitates communication between MQTT clients and devices in the home automation system.

• image: Specifies the Docker image to use for the Mosquitto service. In this case, it uses the official Eclipse Mosquitto image.
• restart: Specifies the restart policy for the container. The unless-stopped option ensures that the container restarts unless explicitly stopped.
• hostname: Defines the hostname for the container.
• container_name: Specifies the name of the container.
• ports: Exposes the MQTT broker on ports 1883 and 9001 on the host machine.
• volumes: Maps a local directory (./mosquitto) to the /mosquitto directory in the container. This volume is used to persist Mosquitto configuration and data.
• command: Specifies the command to run when starting the Mosquitto container. In this case, it runs Mosquitto with a custom configuration file (mosquitto-no-auth.conf) to disable authentication.

🐝 Zigbee2MQTT

The zigbee2mqtt service runs the Zigbee2MQTT bridge, which allows Zigbee devices to communicate with MQTT clients and other services in the home automation system.

• image: Specifies the Docker image to use for the Zigbee2MQTT service. In this case, it uses the latest version of the official Zigbee2MQTT image.
• restart: Specifies the restart policy for the container. The unless-stopped option ensures that the container restarts unless explicitly stopped.
• network_mode: Sets the network mode for the container to host, allowing the container to use the host network stack.
• hostname: Defines the hostname for the container.
• container_name: Specifies the name of the container.
• volumes: Maps local directories (./zigbee2mqtt and /run/udev) to directories in the container. These volumes are used to persist Zigbee2MQTT configuration and data, as well as to access the host’s udev directory.
• environment: Sets the TZ environment variable to Europe/Berlin, specifying the container’s time zone.
• devices: Binds the host device /dev/ttyACM0 to the container device /dev/ttyACM0. This is used to communicate with Zigbee USB dongles connected to the host machine.