This guide provides step-by-step instructions to show you how to install Homebridge on Docker as a service so it will automatically start on boot.

• Prerequisites
  • Synology, Unraid, or QNAP NAS Users:
  • Portainer Users:
  • Firewalla Gold and Purple Users:
• Install Homebridge
  • Step 1: Ensure Docker Compose is installed
  • Step 2: Create Docker Compose Manifest
  • Step 3: Start Homebridge
  • Complete: Login to the Homebridge UI
• Major Node.js Version Updates
• Configuration Reference

Before you get started, make sure you have the following ready:

• A Linux host withDocker installed or a NAS that supports Docker.
• Homebridgedoes not work when running in Docker for Mac or Docker for Windows due tothis andthis.

• Homebridge with Docker on Synology DSM
• Homebridge with Docker on QNAP Container Station
• Homebridge with Docker on Unraid
• Homebridge with Docker on TrueNAS Scale

• Homebridge with Docker using Portainer

• Running Homebridge on Firewalla Gold & Purple with Docker

TheHomebridge Docker image supportsamd64,arm32v6 andarm64v8 host architectures. The correct image for your system will automatically be downloaded.

Docker Compose is the easiest way to start and maintain your Homebridge Docker image. Make sure you have the latest version of thedocker-compose command installed on your system.

Seehttps://docs.docker.com/compose/install/ for instructions.

After ensuring Docker Compose is installed create a new file nameddocker-compose.yml that contains the following:

version:'2'services:homebridge:image:homebridge/homebridge:latestrestart:alwaysnetwork_mode:hostvolumes:      -./volumes/homebridge:/homebridgelogging:driver:json-fileoptions:max-size:"10mb"max-file:"1"

For more details on the environment options see thehomebridge/docker-homebridge project page.

Run the following command to start the Homebridge Docker container:

docker-compose up -d

TheHomebridge UI web interface will allow you to install, remove and update plugins, and modify the Homebridge config.json and manage other aspects of your Homebridge service.

Login to the web interface by going tohttp://<ip address of your server>:8581.

To find the IP address of your server you can run:

hostname -I

Review theConfiguration Reference at the bottom of this guide.

To upgrade Node.js you will need to download the latest version of the Docker image. This can be done using the following commands:

# run these commands from the same directory you created the docker-compose.yml file indocker-compose pulldocker-compose up -d

After running these commands your Homebridge Docker container will automatically restart if there was an update available.

This table contains important information about your setup. You can use the information provided here as a reference when configuring or troubleshooting your environment after setting up Homebridge using the instructions below.