Giter VIP home page Giter VIP logo

homebridge-syno-spk's Introduction

Travis GitHub release

oznu/homebridge-homekit-logo

Synology Package for Homebridge Docker

This third-party Synology Package simplifies the process of running Homebridge on devices that support Docker and are running DSM 6.1.3 or later.

This package will deploy the oznu/homebridge image using the recommended settings:

  • --net=host is set automatically.
  • -e TZ variable is set based on your current timezone of your Synology NAS.
  • -e PUID variable is set to the same UID as the user who installs the package in DSM.
  • -e PGID variable is set to the same GID as the user who installs the package in DSM.
  • -v /homebridge is setup automatically using the directory chosen by you during installation.

How to install

Step 1: Download the latest .spk from here: https://github.com/oznu/homebridge-syno-spk/releases/latest

Step 2: Open Package Center in DSM and select the Manual Install option.

Step 3: Click Yes when warned about using a package from an unknown publisher.

Step 4: Enter the path where you want Homebridge to store it's config.

Step 5: Complete the wizard. The first time you install may take some time as the latest oznu/homebridge image is downloaded from Docker Hub.

Step 6: Use the Homebridge app icon in the main menu to access the Homebridge UI where you can manage your setup.

oznu/homebridge-config-ui-x

The Homebridge Config UI app starts on port 8581. The default username is admin with password admin.

Updating Homebridge

Homebridge can be updated from inside the Config UI. From time to time you may need to upgrade the oznu/homebridge image which can be done by stopping and starting the package in the Synology DSM Package Center.

Adding Additional Packages

Some plugins may require additional packages to be installed which can be done by editing the startup.sh script.

The startup.sh file will be created in the volume you choose during the setup wizard. The Homebridge UI does not provide a way to edit this file so you'll need to do this using DSM or your own computer's editor.

Example startup.sh file to install ffmpeg:

#!/bin/sh

apk add --no-cache ffmpeg ffmpeg-libs

Example startup.sh file to install libpcap-dev:

#!/bin/sh

apk add --no-cache libpcap-dev

To apply the changes made to the startup.sh file you need to restart the entire container using the Docker app in DSM.

Issues

If you have an issue with the installation of Homebridge using this package please raise an issue on this project's GitHub page. For everything else:

Some users have reported not being able to get Homebridge to work at all on their Synology NAS while Bonjour is activated, see this issue for more details.

Contributing

Pull requests are welcome.

Setting up for development

See the Synology DSM 6.0 Developer Guide.

homebridge-syno-spk's People

Contributors

oznu avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.