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.

Image details

Pulls: 4.0M

Architectures: amd64, arm64

Image size: 82 MB

Latest: 5.4.1

User: linuxserver

Created: Apr 08, 2018

Updated: 16 days ago

Status: active

Source details

Repo: bwssytems/ha-bridge

Stars: 1k

Forks: 196

Language: Java

License: Apache-2.0

Latest: v5.4.1 · 4 years ago

Updated: 10 months ago

Configuration

Type

Container

Platform

linux

Image

linuxserver/habridge:latest

Ports

8080:8080/tcp50000:50000/tcp

Volumes

/config : /srv/lsio/habridge/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCSEC_KEY=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/habridge/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Habridge \
  -p 8080:8080/tcp \
  -p 50000:50000/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'SEC_KEY=' \
  -v /srv/lsio/habridge/config:/config \
  --restart=unless-stopped \
  linuxserver/habridge:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  habridge:
    image: linuxserver/habridge:latest
    ports:
      - 8080:8080/tcp
      - 50000:50000/tcp
    volumes:
      - /srv/lsio/habridge/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      SEC_KEY: ''
    restart: unless-stopped

Save this file as habridge-stack.yml, then from a manager node, run docker stack deploy -c habridge-stack.yml habridge

version: '3.8'
services:
  habridge:
    image: linuxserver/habridge:latest
    ports:
      - 8080:8080/tcp
      - 50000:50000/tcp
    volumes:
      - /srv/lsio/habridge/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      SEC_KEY: ''
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`habridge-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: habridge
  labels:
    app: habridge
spec:
  replicas: 1
  selector:
    matchLabels:
      app: habridge
  template:
    metadata:
      labels:
        app: habridge
    spec:
      containers:
        - name: habridge
          image: linuxserver/habridge:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: SEC_KEY
              value: ''
          ports:
            - containerPort: 8080
              protocol: TCP
            - containerPort: 50000
              protocol: TCP
          volumeMounts:
            - name: habridge-data-0
              mountPath: /config
      volumes:
        - name: habridge-data-0
          hostPath:
            path: /srv/lsio/habridge/config

`habridge-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: habridge
spec:
  type: LoadBalancer
  selector:
    app: habridge
  ports:
    - name: 8080-tcp
      port: 8080
      targetPort: 8080
      protocol: TCP
    - name: 50000-tcp
      port: 50000
      targetPort: 50000
      protocol: TCP

Save this file as ~/.config/containers/systemd/habridge.container

[Unit]
Description=Habridge

[Container]
Image=linuxserver/habridge:latest
ContainerName=habridge
PublishPort=8080:8080/tcp
PublishPort=50000:50000/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=SEC_KEY=
Volume=/srv/lsio/habridge/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start habridge

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

For app-specific guidance, check Habridge's own repo at bwssytems/ha-bridge

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/habridge

Supported Architectures

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:latest 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 | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

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

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  habridge:
    image: lscr.io/linuxserver/habridge:latest
    container_name: habridge
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - SEC_KEY=
    volumes:
      - /path/to/habridge/config:/config
    ports:
      - 8080:8080
      - 50000:50000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=habridge \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e SEC_KEY= \
  -p 8080:8080 \
  -p 50000:50000 \
  -v /path/to/habridge/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/habridge:latest

Parameters

Containers 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.
| Parameter | Function | | :----: | --- | | -p 8080:8080 | WebUI | | -p 50000:50000 | HABridge communication port. | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e SEC_KEY= | Key used to secure communication. | | -v /config | Where HABridge stores config files and data. | | --read-only=true | Run container with a read-only filesystem. Please read the docs. |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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:

```bash
docker exec -it habridge /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f habridge
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' habridge
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/habridge:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull habridge
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d habridge
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/habridge:latest
```

Stop the running container:

```bash
docker stop habridge
```

Delete the container:

```bash
docker rm habridge
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-habridge.git
cd docker-habridge
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/habridge:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
27.06.24: - Rebase to Alpine 3.20.
10.04.24: - Revert JRE to 8 due to incomplete upstream support.
20.03.24: - Rebase to Alpine 3.19, bump JRE to 17.
25.08.23: - Rebase to Alpine 3.18.
07.07.23: - Deprecate armhf. As announced here
11.12.22: - Rebasing to alpine 3.17.
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.

Serve Habridge on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying habridge.example.com to http://Habridge:8080

Add this to your Caddyfile

habridge.example.com {
	reverse_proxy http://Habridge:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Habridge
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :8080
Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Habridge can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/habridge/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/habridge:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Habridge --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

SEC_KEY has no default value, and Habridge may crash or misbehave if left empty.

Fill it in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue on bwssytems/ha-bridge
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Homeassistant Home Automation