System Requirements
Homey Self-Hosted Server runs on a all modern Raspberry Pi devices with a 64-bit CPU.
- Raspberry Pi 4
- Raspberry Pi 5
- Raspberry Pi Compute Module 4
- Raspberry Pi Compute Module 5
Next to the model, you need:
- An SD Card with least 8 GB available storage.
- Ethernet or Wi-Fi.
- A Mac or PC to flash the SD Card.
In case you already have a Rasperry Pi set up, and would like to install Homey Self-Hosted Server next to any other services you're already running, please refer to How to install Homey Self-Hosted Server on Linux.
Installing Homey Self-Hosted Server
1. Install Raspberry Pi Imager
Download Raspberry Pi Imager from the Raspberry Pi website, and install it on your Mac or PC.
2. Flash the Operating System
First, insert the SD Card into your computer.
Then open Raspberry Pi Imager, and select either Raspberry Pi 4, or Raspberry Pi 5, based on your model. Click Next.
In the OS step, navigate to Freemium and paid-for OS and select Homey Self-Hosted Server. Click Homey Self-Hosted Server again, and click Next.
In the Storage step, select your SD Card, and click Next.
In the Customisation step, you can set-up your device such as a Username, Password, and Wi-Fi.
The username & password that you choose here are only used connecting to your Raspberry Pi with SSH. They are not your Homey credentials.
In the Writing step, check if everything looks good, and click Write.
3. Power your Raspberry Pi
Once writing is finished, remove your SD Card and place it in your Raspberry Pi.
Connect your Ethernet cable, and provide power to the Raspberry Pi. It will start up.
The first time it starts, it will download a few hundred megabytes. Depending on your internet speed, this could take some time.
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
Simply reboot your Raspberry Pi. Every time it starts, it will check for updates and install them.
Troubleshooting with SSH
In case you need to do some troubleshooting, you can open a remote connection with SSH or Raspberry Pi Connect into your Raspberry Pi.
Viewing the service status
To view the status of the service, execute:
$ sudo systemctl status homey-shsTo view the last 1000 log lines, execute:
$ journalctl -u homey-shs.service -n 1000 -fCreating a Backup
Your userdata is stored in the /homey-shs/ folder. If you ever need to overwrite the SD card, please be sure to create a backup of this folder first, and place it back after flashing the SD card, but before starting the Raspberry Pi.
Help & Troubleshooting
If you're stuck and need help, head over to the Homey Community Forum.
