Homarr
Getting started

Getting started

How Homarr works

Services expose data, integrations connect to them, widgets use the data, and boards arrange the widgets.

1ServiceAPI endpoint
Sonarrsonarr:8989qBittorrentqbittorrent:8080
then
2IntegrationServer-side connection
URL + credentialsFetch data and run actions
then
3WidgetData and actions
CalendarDownloads
then
4BoardPlaced in the grid

Board edit mode

Add items, move them, and resize them on the grid. Each viewport can have its own layout.

Board docs
  1. 1
    Add Choose an app, widget, or container.
    Add item menu in board edit mode
  2. 2
    Move Drag the item to another grid position.
    Dragging an app tile on a board
  3. 3
    Resize Drag the resize handle to change its grid area.
    Resizing an app tile on a board

Requirements

  • linux/amd64 or linux/arm64;
  • 500 MB RAM;
  • 600 MB free disk space for the container image;
  • a persistent writable /appdata directory.

linux/arm/v7 is not supported.

Choose an installation method

RecommendedDocker ComposeGeneral-purpose deployment with a persistent appdata volume.KubernetesHelmDeploy Homarr into an existing cluster.PlatformsNAS and hosting guidesUnraid, TrueNAS, Synology, Portainer, Proxmox, and more.

After Homarr starts, open it in a browser and complete onboarding. Then continue with After the installation for the core concepts and the most useful next links.

Edit this page

Homarr documentation

Install Homarr, connect your services, and build a dashboard that works for you.

Install Homarr

Choose the installation method that matches your infrastructure.

On this page

RequirementsChoose an installation method