Articles in this section

See more

How to install Homey Self-Hosted Server on Linux

  • Updated

System Requirements

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

  • 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.

Installing Homey Self-Hosted Server

1. Open a Terminal

Open a Terminal or connect with SSH to your Linux machine.

2. Install Docker

Install Docker, if it isn't installed already.

$ curl -sSL https://get.docker.com | sh
$ sudo usermod -aG docker $(whoami)
$ exit

3. Install Homey Self-Hosted Server. 

Install and start Homey Self-Hosted Server. It will automatically start upon reboot, until you stop it.

$ docker run \
  --name homey-shs \
  --network host \
  --privileged \
  --detach \
  --restart unless-stopped \
  --volume ~/.homey-shs/:/homey/user/ \
  ghcr.io/athombv/homey-shs

If you prefer Docker Compose, learn more »

4. 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

1. Open a Terminal

Open a Terminal or connect with SSH to your Linux machine.

2. Pull the latest Image

In the terminal, execute the following command to download the latest version.

$ docker pull ghcr.io/athombv/homey-shs

3. Remove the old Container

Stop and remove the old container by executing:

$ docker stop homey-shs
$ docker rm homey-shs

Your data is safe, because it's stored in the ~/.homey-shs folder, which lives outside the container you just removed.

4. Start the new Container

Finally, start a new container by executing:

$ docker run \
  --name homey-shs \
  --network host \
  --privileged \
  --detach \
  --restart unless-stopped \
  --volume ~/.homey-shs/:/homey/user/ \
  ghcr.io/athombv/homey-shs

Creating a Backup

To create a backup, copy the files & folders in ~/.homey-shs to a safe location.

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

Help & Troubleshooting

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

Related articles