explaingit

ajnart/homarr

★ 7,161TypeScriptAudience · ops devopsComplexity · 2/5Setup · easy

TLDR

Homarr is an archived self-hosted dashboard that puts all your home server apps on one customizable start page, drag-and-drop tiles connect to Plex, qBittorrent, Sonarr, Pi-hole, and dozens of other self-hosting apps.

Mindmap

mindmap
  root((Homarr))
    What it does
      Home server dashboard
      Single start page
      App status at a glance
    Integrations
      Plex and Jellyfin
      Download clients
      DNS ad-blockers
      Docker containers
    Setup
      Docker install
      No YAML config needed
      Drag and drop layout
    Status
      Archived legacy version
      Migrate to v1
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Build a single home page that shows live status from all your self-hosted apps like Plex, Sonarr, and Pi-hole.

USE CASE 2

Monitor Docker containers running on your home server directly from the Homarr dashboard.

USE CASE 3

Arrange and rearrange app tiles with drag-and-drop without editing any configuration files.

Tech stack

TypeScriptDockerReact

Getting it running

Difficulty · easy Time to first run · 30min

Archived, no further updates, migrate to homarr-labs/homarr for active development and new features.

In plain English

Homarr is a customizable home server dashboard that provides a single start page for all the services running on a self-hosted server. Instead of opening a dozen browser tabs to check different applications, you get one page where you can see and interact with everything at once. The layout uses a drag-and-drop grid, so you can arrange tiles however you prefer without touching any configuration files. The dashboard connects directly to popular self-hosting applications. Torrent clients like Deluge, Transmission, and qBittorrent show download status. Media servers like Plex and Jellyfin surface what is playing. Media organizers like Sonarr and Radarr display upcoming downloads. DNS ad-blockers like Pi-hole and AdGuard Home are also supported. Each integration has its own documentation, and new ones are added regularly. There is also a Docker integration for monitoring containers, and a built-in icon picker with over 7,000 icons for labeling your tiles. Homarr runs on Docker, unRAID, and Synology, and works on common hardware including x86 machines, Raspberry Pis, and older laptops. A live demo is available at demo.homarr.dev if you want to explore the interface before installing. No YAML configuration files are required to set it up. This repository is archived. The project moved to homarr-labs/homarr starting with version 1.0. If you are using the old version, a migration guide is available on the project's website with instructions for upgrading. The old repository remains available for reading the code or running the legacy version, but no further updates will be made to it. Homarr is maintained by volunteer developers and welcomes community contributions through code, documentation, and translations managed through Crowdin.

Copy-paste prompts

Prompt 1
I want to set up the legacy Homarr v0 dashboard on Docker. Show me a minimal docker-compose.yml to get it running and add my first tile for a Plex server.
Prompt 2
How do I connect Homarr to qBittorrent so it shows download progress on my dashboard? What settings do I need to fill in?
Prompt 3
I'm running the old Homarr and want to upgrade to version 1.0 at homarr-labs. Walk me through the migration steps described in the project's migration guide.
Prompt 4
Show me how to add a custom icon tile in Homarr for an app that does not have a built-in integration.
Open on GitHub → Explain another repo

← ajnart on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.