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
Run the Docker Container
Start Homarr with a single command: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
Create Admin Account
On first launch, you’ll be prompted to create an admin account:
- Enter a username (e.g.,
admin) - Provide a strong password
- Confirm the password
- Click Create Account
Create Your First Board
After logging in:
- Click Create Board or go to the Boards page
- Enter a name for your board (e.g., “Home Lab”)
- Choose whether to make it your home board
- Click Create
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
Port 7575 is already in use
Port 7575 is already in use
Change the port mapping in the docker run command:Then access Homarr at
http://localhost:8080Container won't start
Container won't start
Check the logs for errors: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
Can't create admin account
Can't create admin account
If you accidentally closed the setup page, you can create an admin account using the CLI:Follow the prompts to create a new admin account.
Widgets not loading data
Widgets not loading data
Most widgets require integrations to be configured first:
- Go to Settings → Integrations
- Click Add Integration
- Select the service (e.g., Plex, Sonarr)
- Enter the URL and API key
- Click Test Connection and Save
Environment Variables
You can customize Homarr with environment variables:Updating Homarr
To update to the latest version: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
