Skip to main content
Get Homarr running on your system in just a few minutes. This guide will walk you through the fastest way to deploy Homarr using Docker.

Prerequisites

Before you begin, ensure you have:
  • Docker installed on your system
  • At least 512MB of available RAM
  • Port 7575 available (or choose a different port)
For production deployments, see the Docker Compose guide or Kubernetes guide for more robust setups.

Quick Install with Docker

1

Run the Docker Container

Start Homarr with a single command:
docker run -d \
  --name homarr \
  --restart unless-stopped \
  -p 7575:7575 \
  -v homarr-config:/appdata/config \
  -v homarr-data:/appdata/data \
  -v homarr-icons:/appdata/icons \
  -v homarr-db:/appdata/db \
  ghcr.io/homarr-labs/homarr:latest
This command:
  • Runs Homarr in detached mode (-d)
  • Automatically restarts the container if it stops
  • Exposes Homarr on port 7575
  • Creates persistent volumes for your data
2

Access Homarr

Open your browser and navigate to:
http://localhost:7575
Or replace localhost with your server’s IP address.
3

Create Admin Account

On first launch, you’ll be prompted to create an admin account:
  1. Enter a username (e.g., admin)
  2. Provide a strong password
  3. Confirm the password
  4. Click Create Account
This is the only time you’ll be able to create the first admin account. Make sure to save your credentials securely!
4

Create Your First Board

After logging in:
  1. Click Create Board or go to the Boards page
  2. Enter a name for your board (e.g., “Home Lab”)
  3. Choose whether to make it your home board
  4. Click Create
5

Add Your First Widget

Start customizing your dashboard:
  1. Click Edit in the top right corner
  2. Click Add Widget or drag from the widget panel
  3. Choose a widget type (try “Clock” or “Weather” to start)
  4. Configure the widget settings
  5. Click Save to exit edit mode
Many widgets require integrations. See the Integrations Overview to connect your services.

What’s Next?

Now that you have Homarr running, explore these features:

Connect Integrations

Add connections to Plex, Sonarr, Radarr, and 30+ other services

Explore Widgets

Discover all available widgets and customize your dashboard

Set Up Authentication

Configure OIDC, LDAP, or invite additional users

Production Setup

Deploy with Docker Compose or Kubernetes for production use

Common Issues

Change the port mapping in the docker run command:
docker run -d \
  --name homarr \
  --restart unless-stopped \
  -p 8080:7575 \  # Change 8080 to any available port
  ...
Then access Homarr at http://localhost:8080
Check the logs for errors:
docker logs homarr
Common issues:
  • Port conflict: Use a different port with -p
  • Insufficient memory: Ensure at least 512MB RAM available
  • Volume permission issues: Check Docker volume permissions
If you accidentally closed the setup page, you can create an admin account using the CLI:
docker exec -it homarr homarr recreate-admin
Follow the prompts to create a new admin account.
Most widgets require integrations to be configured first:
  1. Go to SettingsIntegrations
  2. Click Add Integration
  3. Select the service (e.g., Plex, Sonarr)
  4. Enter the URL and API key
  5. Click Test Connection and Save
See the Integrations guide for detailed setup instructions.

Environment Variables

You can customize Homarr with environment variables:
docker run -d \
  --name homarr \
  --restart unless-stopped \
  -p 7575:7575 \
  -e AUTH_SECRET="your-random-secret-here" \
  -e SECRET_ENCRYPTION_KEY="your-encryption-key-here" \
  -v homarr-config:/appdata/config \
  -v homarr-data:/appdata/data \
  -v homarr-icons:/appdata/icons \
  -v homarr-db:/appdata/db \
  ghcr.io/homarr-labs/homarr:latest
Generate secure random values for AUTH_SECRET and SECRET_ENCRYPTION_KEY. These are critical for security!
See the Environment Variables guide for the complete list of configuration options.

Updating Homarr

To update to the latest version:
# Stop and remove the old container
docker stop homarr
docker rm homarr

# Pull the latest image
docker pull ghcr.io/homarr-labs/homarr:latest

# Start with the same command as before
docker run -d \
  --name homarr \
  --restart unless-stopped \
  -p 7575:7575 \
  -v homarr-config:/appdata/config \
  -v homarr-data:/appdata/data \
  -v homarr-icons:/appdata/icons \
  -v homarr-db:/appdata/db \
  ghcr.io/homarr-labs/homarr:latest
Your data persists in Docker volumes, so you won’t lose any configuration.

Need Help?

Join Discord

Get help from the community

Troubleshooting Guide

Common issues and solutions

GitHub Issues

Report bugs or request features

Full Documentation

Explore detailed guides

Build docs developers (and LLMs) love