Skip to content

tobymccann/homebridge-docker

Repository files navigation

homebridge-docker

Docker image for running Homebridge on a Raspberry Pi

Credit goes to ViViDboarder/docker-rpi-homebridge & amitgandhinz/docker-rpi-homebridge for their work on this project.

Homebridge

Here is what the author has to say about Homebridge:

Homebridge is a lightweight NodeJS server you can run on your home network that emulates the iOS HomeKit API. It supports Plugins, which are community-contributed modules that provide a basic bridge from HomeKit to various 3rd-party APIs provided by manufacturers of "smart home" devices.

This project is just a Docker container that makes it easy to deploy Homebridge on your Raspberry Pi.

Getting Docker on your Raspberry Pi

I recommend checking out Alex Ellis' Getting Started with Docker on Raspberry Pi guide

$ curl -sSL get.docker.com | sh

and then

$ sudo usermod -aG docker ${USER}
$ pip install docker-compose

Configuration

There are two files that need to be provided in order for Homebridge to run.

  • config.json: For a quick start, you can copy config-sample.json and modify it to your needs. For detailed explanation of this file, check out the documentation provided by Homebridge
  • plugins.txt: in order to do anything, Homebridge needs to install plugins for your accessories and platforms. You can list them here with each npm package on a new line. See plugins-sample.txt for an example and, again, check out the documentation provided by Homebridge for more details.

Running

This image is hosted on Docker Hub tagged as tobymccann/homebridge-docker, so you can feel free to use the docker-compose.yaml and change build: . to image: tobymccann/homebridge-docker. After that, docker-compose up should get you started.

Alternately, you can compile the image yourself by cloning this repo and using docker-compose

docker-compose up

If you want a little more control, you can use any of the make targets:

make build  # builds a new image
make run    # builds and runs container using same parameters as compose
make shell  # builds and runs an interactive container
make go     # builds and runs container persistently
make tag    # tags image to be pushed to docker hub
make push   # pushes image to docker hub

Issues?

Feel free to report any issues you're having getting this to run on Github

About

Dockerized Homebridge

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published