Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Homarr

Homarr is a self-hosted dashboard for organizing homelab apps and services. It provides a drag-and-drop UI, built-in Docker integration, health/status widgets, and app tiles without maintaining a large YAML dashboard by hand.

Architecture

Browser
  |
  v
Traefik (TLS termination, lan-only)
  |
  v
homarr:7575
  |
  +-- /appdata persisted on the host
  +-- /var/run/docker.sock mounted read-only for Docker integration

Prerequisites

Create the host data directory before first deploy:

mkdir -p /mnt/SSD/Containers/homarr

Generate a stable encryption key and store it in .env:

openssl rand -hex 32

Do not rotate SECRET_ENCRYPTION_KEY unless you are intentionally resetting encrypted Homarr integration secrets.

Quick Start

cp example.env .env
$EDITOR .env
docker compose up -d

Access Homarr at https://${HOMARR_DOMAIN}.

Environment Variables

Variable Required Description
HOMARR_DOMAIN Yes Traefik domain for the web UI
SECRET_ENCRYPTION_KEY Yes 64-character hex key for encrypting stored integration secrets

Notes

  • The Docker socket is mounted read-only so Homarr can discover containers without giving it write access to the Docker daemon.
  • The healthcheck uses /api/health/live, not /. Hitting / as an unauthenticated healthcheck can trigger repeated No home board found errors in Homarr logs because the homepage route tries to resolve a default board.