Homarr documentation
Install Homarr, connect your services, and build a dashboard that works for you.
Install or upgrade
Install Homarr
Start with Docker Compose, Kubernetes, or your hosting platform.
Update Homarr
Update your Docker installation while keeping its data and configuration.
New to Homarr? Learn how boards, apps, integrations, and widgets fit together, then complete your first-board setup.
Configure your dashboard
| I want to… | Guide |
|---|---|
| Add links to my services | Apps and bookmarks |
| Arrange and share a dashboard | Boards |
| Connect a service to Homarr | Find an integration |
| Display service data on a board | Choose a widget |
| Install a community widget or style | Use the Workshop |
| Manage access for other people | Users and permissions |
Operate your installation
- Environment variables: deployment settings and defaults.
- Single sign-on: credentials, LDAP, and OIDC configuration.
- Scheduled tasks: background work and task status.
- Get help: support channels and ways to contribute.
Extend Homarr
Build a Custom Widget, connect an AI client with MCP, or use the HTTP API reference. For changes to Homarr itself, follow the development setup.