add-on, add-on store, supervisor, ingress, update, upgrade
Home Assistant Addon
The easiest way to run GlassHome if you’re on Home Assistant OS or Home Assistant Supervised. The addon runs GlassHome next to Home Assistant; GlassHome stays its own app with its own address.
Prerequisites
- Home Assistant OS or Home Assistant Supervised (both include the Add-on Store with Supervisor).
- A 64-bit device: Raspberry Pi 4 or 5, or an x86-64 machine with SSE4.2. See Supported CPUs.
Installation
- 1
Add the repository
Add GlassHome to your addon store.
Add Repository
Button didn't work? Add manually
Open Settings > Add-ons > Add-on Store, click the ⋮ menu (top-right) and choose Repositories. Paste this URL and click Add:
https://github.com/glasshome/homeassistant-addon - 2
Install the addon
Find GlassHome in the Add-on Store and click Install.
- 3
Start and access
Start the addon. Open
http://<ha-ip>:3123in your browser. - 4
Connect Home Assistant
The welcome screen finds Home Assistant and asks you to sign in once. Every screen, with pictures: Connect Home Assistant.
Opens outside Home Assistant
GlassHome does not appear in the Home Assistant sidebar or the Home Assistant app. Ingress will never be supported: the way GlassHome and its widgets are built cannot run inside Home Assistant. Open it directly at http://<ha-ip>:3123, where <ha-ip> is the IP address of your Home Assistant machine. Away from home, Nabu Casa does not reach it either; see Remote Access.
Updating
Check Settings > Add-ons for available updates. You’ll see a notification when a new version is available.
Edge Channel
The same repository includes GlassHome Beta (unstable), the Edge channel. It carries test builds for trying new features and reporting what breaks. Enable Advanced Mode in your HA profile to see it in the Add-on Store. It runs on port 3124, so it can run side by side with the stable addon.
Beta breaks often
Features come and go, and boards may need redoing. Never make it your only dashboard. Use the stable version for your daily driver.
A beta build wears a small “beta” ribbon in the bottom-right corner of the dashboard, and a release candidate wears “rc”. The ribbon cannot be turned off. GlassHome asks once whether you understand it can break, the first time you open the first beta of a new version; tap “I understand this can break” to continue. It asks once more at that version’s first release candidate. Settings shows the version with its stage, for example “Beta 1.5.0-beta.3”.
To go back to stable, stop and uninstall GlassHome Beta (unstable), then install GlassHome Dashboard from the same repository. Beta dashboards and settings do not carry over.
Troubleshooting
- Addon not visible after adding the repository. Refresh the Add-on Store page (the ⋮ menu has a “Check for updates” option). It can take a moment for the new addon to appear.
- Addon fails to start: port conflict. Port 3123 may already be in use on your HA host. Check for other services listening on that port and stop them before starting GlassHome.
- Addon fails to start: unsupported architecture. GlassHome requires a 64-bit CPU (Pi 4/5, x86-64 with SSE4.2). 32-bit installs and Pi 3 are not supported. See Supported CPUs.
Related docs
- Connect Home Assistant: the welcome screen, step by step
- Connecting to Home Assistant: pair Dash with HA after install
- Docker installation: alternative install for non-HAOS setups
- Quickstart: first dashboard in five minutes
- Troubleshooting: common install issues