How to install Homey Self-Hosted Server with Docker on Linux

System Requirements

Homey Self-Hosted Server runs on a variety of hardware, with a minimum set of requirements.

• A Linux-based OS, such as Debian or Ubuntu.
• An Intel/AMD or Arm 64-bit CPU.
• At least 1 GB available RAM.
• At least 1 GB available storage.
• A dedicated LAN IP address.

When running inside a VM, choose Bridged Networking to give the VM a dedicated IP address on your LAN.

Running Docker Desktop on Windows or macOS? Please refer to the guides for Windows and macOS.

Installing Homey Self-Hosted Server

This guide assumes that you have already installed Docker.

1. Create a Docker Compose file

Create a file homey-shs.yml on your computer with the following contents.

services:
  homey-shs:
    image: ghcr.io/athombv/homey-shs:latest
    container_name: homey-shs
    restart: unless-stopped
    network_mode: host
    privileged: true
    volumes:
      - ~/.homey-shs:/homey/user

You can of course change the path from ~/.homey-shs to any directory you'd like.

2. Start the Container

In a terminal, execute:

$ docker compose -f homey-shs.yml up --detach

To view logs, execute:

$ docker compose -f homey-shs.yml logs --follow

3. Continue on iPhone & Android

Open the Homey app for iOS or Android to add a new Homey, and select Self-Hosted Server.

Updating Homey Self-Hosted Server

To update Homey Self-Hosted Server, navigate to the directory where you placed homey-shs.yml and execute the following.

$ docker compose -f homey-shs.yml pull
$ docker compose -f homey-shs.yml up --detach

Creating a Backup

To create a backup, copy the files & folders in the path you selected during installation, e.g. ~/.homey-shs, to a safe location.

To restore a backup, put them back before starting Homey Self-Hosted Server.

Environment Variables

While there should be no need to configure anything with Environment Variables, these can be used in some scenarios.

Help & Troubleshooting

If you're stuck and need help, head over to the Homey Community Forum.