Installation

Installation

There are two ways to run Glance: as a Home Assistant add-on (recommended for most people) or locally for development.

---

Option 1 — Home Assistant Add-on (Ingress)

Runs on the HA server itself and shows up as the Glance panel in the sidebar. Requires a Supervisor (HA OS or Supervised). HA Container/Core have no add-on store and cannot use this.

One-click

Open the Add repository dialog pre-filled in your own HA:

https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fjvenuto80%2FDynamic-HA-Dashboard

Then click Add.

The button only adds the repository — it does not install the add-on, and on some HA/browser versions it just opens the Add-on Store without the dialog. If that happens, use the manual steps below.

Manual (always works)

1. Settings → Add-ons → Add-on Store.
2. Top-right ⋮ menu → Repositories.
3. Paste and Add, then Close:

   https://github.com/jvenuto80/Dynamic-HA-Dashboard
   

4. Refresh the store. A new Glance — HA Dashboard Add-ons section appears.
5. Open Glance — HA Dashboard → Install → Start → Open Web UI (it also appears as Glance in the sidebar).

First install builds from source on your device (clones the repo + npm run build), so it can take several minutes and needs internet access.

Next: Configuration for first-time token setup.

Direct port access (Fully Kiosk Browser, tablets, wall displays)

By default the add-on is served through Ingress only (no exposed port — it inherits HA's authentication). To point a kiosk browser straight at the dashboard, give it a direct port:

1. Open the add-on → Network tab.
2. Map host port 3000 to the container's 3000/tcp (or any free host port you prefer).
3. Save and restart the add-on.

Then browse to http://<home-assistant-ip>:3000. The dashboard listens on container port 3000.

---

Option 2 — Local development

npm install
npm run dev        # Vite dev server on http://localhost:3000
npm run build      # tsc -b + vite build  → dist/
npm run preview    # serve the production build

Strict TypeScript is enforced (noUnusedLocals); the build must be 0 errors.

Set connection values via .env (copy .env.example → .env) or in the in-app Settings modal. See Configuration.

---

Updating the add-on

When a new version is published, the add-on page shows an Update button. After updating, restart the add-on so the sidebar panel re-registers (see Troubleshooting if the panel name looks stale).