HomeBridge#

HomeBridge HomeKit support for the impatient

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling homebridge#

Command:#

vlab set homebridge.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
enable: True

Finalising changes:#

run: vlab update_one service=homebridge

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, homebridge makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=homebridge to complete the changes

ACCESS#

homebridge (HTTPS) link: https://homebridge.vivumlab.xyz/ homebridge (HTTP) link: http://homebridge.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set homebridge.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
https_only: True
Finalising changes:#

run: vlab update_one service=homebridge

AUTH#

Default: False
Options: True/False

Command:#

vlab set homebridge.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
auth: True
Finalising changes:#

run: vlab update_one service=homebridge

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set homebridge.domain homebridge.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
domain: homebridge.com
Finalising changes:#

run: vlab update_one service=homebridge

SUBDOMAIN#

Default: homebridge
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set homebridge.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
subdomain: media
Finalising changes:#

run: vlab update_one service=homebridge

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set homebridge.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

homebridge
version: 2.7
Finalising changes:#

run: vlab update_one service=homebridge

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.