Installation: HA OS App
Choosing an installation method
There are two ways to run Superhome. Decide which one fits your setup, then follow the matching guide:
- All-in-one (this guide). Everything runs on the Home Assistant OS host: inference, web UI, and the Home Assistant integration. This is the simplest option and the right choice for most users, especially single-host setups like a Pi 5 or a mini-PC running HAOS.
- Master-Worker cluster. The Home Assistant app stays the "master" (license, Hub UI, HA integration) while a separate machine runs the AI inference and has the camera connected to it. Choose this if your HA host is too lightweight for inference, or if you want the camera close to a dedicated machine. See Master-Worker Cluster.
The steps below cover the all-in-one method.
Steps
1. Add the Superhome repository to Home Assistant
Superhome is distributed as a custom Home Assistant repository. You add it once, and the app then shows up in your store.
1a. In Home Assistant, go to Settings → Apps → Install app.
1b. Click the three-dot menu (⋮) in the top-right corner and choose Repositories.
1c. Paste the Superhome repository URL and click Add:
https://github.com/superhome-vision/superhome
1d. Close the dialog.
You only need to add the repository once. After this, every future update of Superhome appears automatically in the store.
2. Install the app
Refresh the store page, scroll down to the Superhome section, click on the app, then click Install. The first installation downloads and unpacks the image; plan for around 10 to 15 minutes depending on your hardware and internet speed. This happens only once.
3. Configure the app
Open the Configuration tab and fill in at minimum:
| Field | Value |
|---|---|
license_key | Your SH-XXXX-XXXX-XXXX-XXXX key |
rtsp_url | Your camera stream, e.g. rtsp://192.168.1.50:554/stream1 |
Click Save.
4. Start the app
Before starting, open the Info tab and:
- Enable Watchdog so Superhome restarts automatically if it ever stops.
- Optionally enable Show in sidebar to open the Superhome Hub directly from the Home Assistant menu.
Now click Start. The first start takes about a minute to get ready. Once it has started, click Open Web UI to access the Hub, or open Superhome from the sidebar if you enabled the side panel.
The Hub is accessible only from within Home Assistant (through the app's ingress panel or the sidebar entry). There is no URL or port to remember.
Next step
→ Set up your camera to get the right RTSP URL.
→ Want to offload inference to a dedicated machine? See Master-Worker Cluster.