How gethomepage/homepage works
Homepage is a configurable self-hosted dashboard: users view service links and bookmarks, monitor integrations, and use utility widgets and search. Configuration is loaded from YAML and can include Docker label discovery; the page combines configured data with rendered components. Widget requests are served through backend APIs, which query external services while keeping credentials server-side. The README also documents themes, layouts, localization, and optional authentication. Wiring for some unsampled subsystems is represented at directory-level only; edges are limited to documented behavior and sampled call relationships.
Main entry points: index.jsx Homepage page · widgets/index.js Widget API · services/index.js Services API · components.js Service widgets
Components 22
Dashboard UI
- Homepage page
src/pages/index.jsx - Services and bookmarks
src/components/services/list.jsx - Service widgets
src/widgets/components.js - Information widgets
src/components/widgets/widget.jsx - Search and quicklaunch
src/components/quicklaunch.jsx
Configuration
- Settings and config
src/utils/config/config.js - Service config loader
src/utils/config/service-helpers.js - Widget config loader
src/utils/config/widget-helpers.js - Config API
src/pages/api/config/[path].js
Integrations
- Docker integration
src/utils/config/docker.js - Services API
src/pages/api/services/index.js - Widget API
src/pages/api/widgets/index.js - Widget request proxy
src/utils/proxy/use-widget-api.js - Kubernetes status and stats
src/pages/api/kubernetes/status/[...service].js - Proxmox stats
src/pages/api/proxmox/stats/[...service].js
Utilities
- Search suggestions
src/pages/api/search/searchSuggestion.js
Security
- Optional authentication
src/pages/api/auth/[...nextauth].js
Other components
- Dashboard user
- YAML configuration
- Self-hosted services
- Search providers
- OIDC provider
Connections 26
- Dashboard user → Homepage page: opens dashboard
- Homepage page → Settings and config: loads settings
- Homepage page → Services API: requests services
- Homepage page → Widget API: requests widgets
- Services API → Service config loader: loads service config
- Widget API → Widget config loader: loads widget config
- YAML configuration → Settings and config: provides settings
- YAML configuration → Service config loader: provides services
- YAML configuration → Widget config loader: provides widgets
- Service config loader → Docker integration: discovers containers
- Services API → Services and bookmarks: returns groups
- Widget API → Service widgets: returns definitions
- Homepage page → Services and bookmarks: renders groups
- Homepage page → Service widgets: renders widgets
- Homepage page → Information widgets: renders utilities
- Service widgets → Widget request proxy: requests widget data
- Widget request proxy → Widget API: fetches data
- Widget API → Self-hosted services: queries integrations
- Kubernetes status and stats → Self-hosted services: queries Kubernetes
- Proxmox stats → Self-hosted services: queries Proxmox
- Homepage page → Config API: loads custom assets
- Homepage page → Search and quicklaunch: opens quicklaunch
- Search and quicklaunch → Search suggestions: fetches suggestions
- Search suggestions → Search providers: requests suggestions
- Dashboard user → Optional authentication: signs in
- Optional authentication → OIDC provider: authenticates with