From 204b9f47fd034131249c624c5796541242193a35 Mon Sep 17 00:00:00 2001 From: Marco Raddatz <info@marcoraddatz.com> Date: Mon, 19 Mar 2018 21:28:13 +0100 Subject: [PATCH] Version bump; moved readme contents to Wiki --- CHANGELOG.md | 5 ++ Dockerfile | 2 +- README.md | 133 +-------------------------------------------------- VERSION | 2 +- 4 files changed, 9 insertions(+), 133 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9963d67..d47b314 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## 4.3 +- Default Homebridge version is v0.4.38 +- Updated Node.js to version 9.8 +- Moved readme contents to Wiki (https://github.com/marcoraddatz/homebridge-docker/wiki) + ## 4.2 - Default Homebridge version is v0.4.33 - Added option to set DiskStation hostname ([\#7](https://github.com/marcoraddatz/homebridge-docker/issues/7)) diff --git a/Dockerfile b/Dockerfile index 2e5e6dd..3585fe6 100755 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM node:9.2-stretch +FROM node:9.8-stretch MAINTAINER Marco Raddatz diff --git a/README.md b/README.md index d77f88d..e547b59 100644 --- a/README.md +++ b/README.md @@ -5,138 +5,9 @@ [This Docker image](https://hub.docker.com/r/marcoraddatz/homebridge/) helps you to easily setup [Homebridge](https://github.com/nfarina/homebridge) on your Synology, but also runs on QNAP devices or Raspberry Pies. If you're using a Synology, please make sure to run at least DSM 6, otherwise you [might have to go the harder way](https://marcoraddatz.com/en/2016/07/13/run-homebridge-on-a-synology/) via SSH/shell scripts. -## Installation (via Synology DSM) +## Docs -### 1. Download Image - -First of all, login to your Synology DSM, open Docker and download `marcoraddatz/homebridge` from within the registry. - -![Registry Overview.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-1.png) - -### 2. Prepare your scripts - -Create a folder via DSM File Station at `/volume1/docker/homebridge` and put your `config.json` and **either** your `package.json` or `install.sh` (recommended) in there. If you'd like to develop an own plugin or debug Homebridge, also copy the `.env` file. - -![File Station.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/file-station-1.png) - -Here are two examples of how your setup files may look like: - -#### [package.json](samples/package.json) - -```json -{ - "name": "DiskStationHomeBridge", - "description": "HomeKit support for the impatient.", - "version": "0.1.1", - "license": "ISC", - "dependencies": { - "homebridge-harmonyhub": "0.2.0-alpha", - "homebridge-netatmo": "^0.0.4", - "homebridge-nukiio": "^0.0.3", - "homebridge-synology": "^0.1.0" - } -} -``` - -#### [install.sh](samples/install.sh) - -*Note that you can also use this file to install server dependencies!* - -```shell -#!/bin/bash - -npm install -gs homebridge-harmonyhub -npm install -gs homebridge-netatmo -npm install -gs homebridge-nukiio -npm install -gs homebridge-synology -``` - -Since version 2.1 all commands get executed as root, so this is a good place to install missing dependencies. - -### 3. Start Container - -Once the plugins have been set up, the Docker container is ready to launch. - -![Launch container.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-2.png) - -![Click 'Advanced Settings'.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-3.png) - -![Link local configs.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-4.png) - -Link the `/volume1/docker/homebridge` to `/root/.homebridge`, otherwise, the configuration files won’t be loaded (within DSM the path is only shown as `/docker/homebridge`. - -![Use the same network as Docker host.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-5.png) - -![Apply settings.](https://raw.githubusercontent.com/marcoraddatz/homebridge-docker/master/doc/docker-6.png) - -Once you launch (or restart) the container, Homebridge and all its dependencies will get installed. To verify that Homebridge is running or if an error occurs, you can use the container's log (Container → Details → Log) to receive further information on the process. - -## Command line - -There are many Docker commands that can be run via the `homebridge.sh` script. Please have a look [at the file](homebridge.sh), it should be self-explaining. - -## Plugin development - -If you intend to develop a plugin or Homebridge is not running as it's supposed to, you might want to start Homebridge with debugging options. To do so, copy the sample `.env` file to `/volume1/docker/homebridge` and set the desired environment. Don't forget to place your plugins manually under `/volume1/docker/homebridge/plugins` and (re-) start the container. See the [Homebridge docs](https://github.com/nfarina/homebridge#plugin-development) for details. - -### .env options - -All `.env` variables are optional. - -#### HOMEBRIDGE_ENV - -- **production** _(default)_ -Starts Homebridge without any options. -- **development** -Starts Homebridge with plugin support. -- **debug** -Starts Homebridge with plugin support and maximum debugging info. -- **production-insecure** -Starts Homebridge with HTTP support. -- **development-insecure** -Starts Homebridge with plugin support and HTTP support. -- **debug-insecure** -Starts Homebridge with plugin support, HTTP support and maximum debugging info. - -#### HOMEBRIDGE_TIMEZONE - -Manually set a timezone. (This environment variable is equal to Linux' TZ variable.) See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid options. If no timezone is set, UTC will be used. - -#### HOMEBRIDGE_VERSION - -To avoid breaks with either new Homebridge releases or iOS updates, you can force the installation of a specific Homebridge version. `HOMEBRIDGE_VERSION` accepts any release tag (f.e "0.4.17") or valid NPM version range. - -## Troubleshooting - -In case, that Homebridge doesn't run as expected, please follow these steps for debugging: - -### 1. Avoid multiple Homebridge instances - -A lot of issues come through multiple Homebridge instances. Conflicts might require you to completely re-setup Homekit on your iOS devices! **Always make sure, there's only one Homebridge instance running on your network at once!** - -### 2. Verify your `config.json` - -Many issues appear because of invalid JSON. Before you open a ticket, please make sure that the syntax is ok. A good way to verify your config is to use the [jsonlint.com](http://jsonlint.com) validator. - -### 3. Disable Plugins - -Most issues aren't related to this package, nor to Homebridge -- they are created by outdated plugins or wrong configuration. This package focuses on making Homebridge run as easy as possible. So if Homebridge runs without any plugins, enable them step by step until you find out, which plugin creates the error. You should then contact the plugin's creator. - -### 4. Open ports - -Make sure that ports 5353 and 51826 (both TCP) aren't blocked by your firewall. - -### 5. Set a hostname (Synology only) - -To avoid conflicts with other devices, set the `DS_HOSTNAME` variable in the `.env` file to your DiskStation's server name (uncomment it first!). The value should exactly match the server name as shown under `Synology DSM Control Panel` -> `Info Centre` -> `Server name`. It should contain no spaces or special characters. - -### 6. Adjust paths (Non-Synology only) - -If you're using a non-Synology device, you might need to adjust the paths to your config (`/volume1/docker/homebridge`). - -### 7. Search the GitHub issues - -Before opening a new [issue on GitHub](https://github.com/marcoraddatz/homebridge-docker/issues), please use the search function to avoid duplicates. +All information can be found in our [Wiki](https://github.com/marcoraddatz/homebridge-docker/wiki). ## License diff --git a/VERSION b/VERSION index bf77d54..69df05f 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -4.2 +4.3