# GlassHome

> Local-first dashboard for Home Assistant. Runs on your hardware, connects to HA over WebSocket, customized in the UI (no YAML). Hub (this domain) hosts the widget registry and provisions optional remote-access tunnels.

## Key facts

- The dashboard app and Home Assistant talk directly on your LAN. Hub is never in the data path.
- Install methods: HA Add-on (HAOS), Docker Compose, standalone container. Multi-arch (amd64 + aarch64).
- CPU requirements: SSE4.2 (x86) or ARMv8. Virtualized hosts often need a `host` CPU profile.
- Widgets: SolidJS component + Zod config, built and published via `@glasshome/widget-cli`.
- A Hub account is only required to publish widgets, manage organizations, or use the managed tunnel.
- Free tier: $0, connect to Home Assistant with all official widgets, no account needed. PRO: $19.99 early bird price (standing $39.99), one-time purchase, unlocks community widgets + custom theming. Details: https://glasshome.app/pricing.md

## Docs

### Getting Started

- [Documentation](https://glasshome.app/md): GlassHome is a modern, local-first dashboard for Home Assistant. Install in minutes, customize without YAML.
- [Quickstart](https://glasshome.app/md/quickstart): Install GlassHome, connect it to Home Assistant, and add your first widget in under 5 minutes.
- [Concepts](https://glasshome.app/md/concepts): The GlassHome mental model. Dash, Hub, addon, widget, tunnel. What each piece is, where it runs, and how they connect.
- [Installation](https://glasshome.app/md/installation): Install GlassHome as a Home Assistant addon, Docker Compose service, or standalone container. CPU requirements and VM gotchas covered.
- [Connecting to Home Assistant](https://glasshome.app/md/connecting): Pair GlassHome with your Home Assistant instance via OAuth. Setup wizard, demo mode, URL format pitfalls, and reconnection.

### Dashboard

- [Widgets](https://glasshome.app/md/widgets): Widget types built into Dash, configuring widgets, community widgets from Hub, and building your own.
- [Layouts](https://glasshome.app/md/layouts): Responsive grid breakpoints and managing multiple dashboards. Layouts are per breakpoint and per dashboard.
- [Editing Your Dashboard](https://glasshome.app/md/editing): Enter edit mode, add and remove widgets, move and resize tiles. Full gesture reference for live and edit mode.
- [Themes](https://glasshome.app/md/themes): 7 free theme presets with light/dark mode. The theme editor (colors, radius, backgrounds, upload) requires Pro.
- [Widget Security](https://glasshome.app/md/widget-security): How GlassHome keeps third-party widgets from leaking your home data or controlling devices you did not approve. Plain language, layered, and honest about what is not yet covered.

### Developers

- [Widget Development](https://glasshome.app/md/widget-development): Build custom GlassHome widgets with SolidJS and the widget SDK. Scaffold, develop with hot-reload, validate, and publish.
- [Widget SDK](https://glasshome.app/md/widget-sdk): The GlassHome widget SDK API. defineWidget, Widget components, hooks, entity bindings, and theming.
- [Capabilities & Permissions](https://glasshome.app/md/widget-capabilities): How a widget declares the Home Assistant access it needs. The capability grammar, access levels, narrowing to entities and services, what the user approves, and how the host enforces it.
- [Styling & Animation](https://glasshome.app/md/widget-styling): How widget styling works in the GlassHome SDK — per-widget CSS bundles, Tailwind utilities, your own CSS files, theme variables, container queries, and animation.
- [Widget CLI](https://glasshome.app/md/widget-cli): All CLI commands for creating, building, testing, and publishing GlassHome widgets.
- [Publishing Widgets](https://glasshome.app/md/widget-publishing): Publish your GlassHome widgets to Hub. Login, validate, version, select scope, and publish.
- [Config Migrations](https://glasshome.app/md/widget-migrations): Handle breaking widget config changes across versions with configVersion and migrate functions.
- [Upgrading to SDK 1.0](https://glasshome.app/md/widget-sdk-1-0): What changed in widget-sdk 1.0 — shadow-root rendering, separate CSS, capability declarations, and no direct Home Assistant access — and how to migrate a widget.

### Deployment

- [Home Assistant Addon](https://glasshome.app/md/addon): Install GlassHome as a Home Assistant addon. One-click setup for HAOS and Supervised users.
- [Docker Deployment](https://glasshome.app/md/docker): Deploy GlassHome with Docker Compose or standalone container. Multi-arch image, amd64 and aarch64 auto-selected.
- [Remote Access](https://glasshome.app/md/remote-access): Access your Dash from outside your home network. VPN works today; managed tunnel is in progress.

### Hub

- [Organizations](https://glasshome.app/md/organizations): Create and manage organizations on GlassHome Hub to publish widgets under a shared team scope.
- [Pro](https://glasshome.app/md/pro): What GlassHome Pro unlocks, how the free tier compares, how to buy, and how to manage your one-time Pro license.
- [API Reference](https://glasshome.app/md/api-reference): GlassHome Hub public HTTP API. Versioned widget catalog endpoints for external integrators.

### Reference

- [Glossary](https://glasshome.app/md/glossary): A-Z definitions of GlassHome terminology. Quick lookup for terms used across the docs.
- [Changelog](https://glasshome.app/md/changelog): Release history for GlassHome Dashboard and Hub. Authoritative source is the GitHub Releases page.

### Support

- [FAQ](https://glasshome.app/md/faq): Frequently asked questions about GlassHome. Local-first, Home Assistant, hardware, accounts, privacy, and licensing.
- [Troubleshooting](https://glasshome.app/md/troubleshooting): Look up GlassHome errors and fixes by symptom or message. Illegal instruction, container won't start, CORS, connection drops, and more.
- [Bug Reports](https://glasshome.app/md/bug-reports): How to report bugs in GlassHome. What to include, where to find logs, and how to help get it fixed fast.

## How to navigate

- New users: start with `/md/quickstart`, then `/md/concepts` for the mental model.
- Operators: `/md/installation`, `/md/docker`, `/md/addon`, `/md/troubleshooting`.
- Widget authors: `/md/widget-development`, then `/md/widget-sdk` and `/md/widget-cli`.
- Each doc is available as plain Markdown at `/md/<slug>` (frontmatter-prefixed).