Search…
Images
Powered By GitBook
linuxserver/habridge
Habridge emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API.
In the cases of systems that require authorization and/or have APIs that cannot be handled in the current method, a module may need to be built. The Harmony Hub is such a module and so is the Nest module. The Bridge has helpers to build devices for the gateway for the Logitech Harmony Hub, Vera, Vera Lite or Vera Edge, Nest, Somfy Tahoma, Home Assistant, Domoticz, MQTT, HAL, Fibaro, HomeWizard, LIFX, OpenHAB, FHEM, Broadlink and the ability to proxy all of your real Hue bridges behind this bridge.
This bridge was built to help put the Internet of Things together.
For more information about how to use this software have a look at their Wiki https://github.com/bwssytems/ha-bridge/wiki

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/habridge should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

To set up the ha-bridge simply go to http://localhost:8080. Once you are in the webui you can add devices and configure ha-bridge to your liking.
For information on how to configure ha-bridge, go to their wiki at https://github.com/bwssytems/ha-bridge/wiki

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
habridge:
5
image: lscr.io/linuxserver/habridge
6
container_name: habridge
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- SEC_KEY=<Your Key To Encrypt Security Data>
11
- TZ=Europe/London
12
volumes:
13
- <path to data>:/config
14
ports:
15
- 8080:8080
16
- 50000:50000
17
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=habridge \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e SEC_KEY=<Your Key To Encrypt Security Data> \
6
-e TZ=Europe/London \
7
-p 8080:8080 \
8
-p 50000:50000 \
9
-v <path to data>:/config \
10
--restart unless-stopped \
11
lscr.io/linuxserver/habridge
Copied!

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter
Function
8080
WebUI
50000
HABridge communication port.

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
SEC_KEY=<Your Key To Encrypt Security Data>
Key used to secure communication.
TZ=Europe/London
Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume
Function
/config
Where HABridge stores config files and data.

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

    Shell access whilst the container is running:
      docker exec -it habridge /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f habridge
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' habridge
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/habridge

Versions

    23.01.21: - Rebasing to alpine 3.13.
    01.06.20: - Rebasing to alpine 3.12.
    19.12.19: - Rebasing to alpine 3.11.
    28.06.19: - Rebasing to alpine 3.10.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    22.02.19: - Rebasing to alpine 3.9.
    11.02.19: - Add pipeline logic and multi arch.
    28.08.18: - Rebase to alpine 3.8.
    12.04.18: - Add workaround to bind to port 80 if needed.
    08.04.18: - Initial Release.
Last modified 23d ago