vividboarder/docker-rpi-homebridge
2
0
Fork 0
mirror of https://github.com/ViViDboarder/docker-rpi-homebridge.git synced 2024-12-22 09:57:37 +00:00
Code Issues Releases Wiki Activity
Docker image for running Homebridge on a Raspberry Pi
6 Commits 6 Branches 0 Tags 55 KiB
Makefile 59.4%
Dockerfile 30.6%
Shell 10%
a240d7b3e4
Go to file
ViViDboarder a240d7b3e4 add cross-arch building with node8 base
2017-07-04 16:42:23 -07:00
.gitignore Initial code commit 2016-11-14 22:41:21 +00:00
config-sample.json Initial code commit 2016-11-14 22:41:21 +00:00
docker-compose.yaml Fix avahi and clean build 2016-11-15 01:01:34 +00:00
Dockerfile add cross-arch building with node8 base 2017-07-04 16:42:23 -07:00
LICENSE Initial commit 2016-11-14 14:32:14 -08:00
Makefile Fix avahi and clean build 2016-11-15 01:01:34 +00:00
plugins-sample.txt Initial code commit 2016-11-14 22:41:21 +00:00
README.md Add issue link 2016-11-14 17:54:20 -08:00
start.sh Fix avahi and clean build 2016-11-15 01:01:34 +00:00

README.md

docker-rpi-homebridge

Docker image for running Homebridge on a Raspberry Pi

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 Hypriot and their Getting Started guide

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 vividboarder/rpi-homebridge, so you can feel free to use the docker-compose.yaml and change build: . to image: vividboarder/rpi-homebridge. 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 interractive container
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