Portainer Templates logo

Portainer Templates

Homarr (stack) Homarr (stack)

Dashboard

Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips.

Image details

Architecture: amd64, arm64, arm/v7
Image size: 374 MB
User: ajnart

Source details

Repo: ajnart/homarr
Stars: 7k
Forks: 304
Language: TypeScript
License: MIT
Latest: v0.16.0 · 1 years ago
Updated: 2 months ago
Website: homarr.dev/
Status: archived

Configuration

Type
Compose
Platform
linux
Image
ghcr.io/ajnart/homarr:latest
Ports
7575:7575
Volumes
/app/data/configs : /portainer/Files/AppData/Config/homarr/configs/app/public/icons : /portainer/Files/AppData/Config/homarr/icons/var/run/docker.sock : /var/run/docker.sock
Env vars
TZ=Europe/AthensDEFAULT_COLOR_SCHEME=dark
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Homarr (stack)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Homarr (stack), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  homarr:
    container_name: homarr
    image: ghcr.io/ajnart/homarr:latest
    restart: unless-stopped
    environment:
      - TZ=Europe/Athens
      - DEFAULT_COLOR_SCHEME=dark
    volumes:
      - /portainer/Files/AppData/Config/homarr/configs:/app/data/configs
      - /portainer/Files/AppData/Config/homarr/icons:/app/public/icons
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 7575:7575

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/homarr.yml up -d

More install options in our documentation, or see ajnart/homarr for app-specific guidance.

🦀 Homarr

This repository has been archived and the project was moved to homarr-labs/homarr with v1+. There will be no updates to this old version, but you can enjoy regular updates with v1+.
Usage of this old project is not recommended, however possible.
To migrate please follow the Migration Guide and read the Breaking Changes













Banner

  Latest Release (Semver)   CI Status   


<strong>Demo ✨</strong>
• 
<strong>Install 💻</strong>
 • 
<strong>Translations 🈺</strong>
 • 
<strong>Discord 👋</strong>


Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one convenient location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods.



Features Section
  • 🖌️ Highly customizable with an extensive drag and drop grid system
  • ✨ Integrates seamlessly with your favorite self-hosted applications
  • 📌 Easy and fast app management - no YAML involved
  • 🙊 Advanced secrets' management system for enhanced security
  • 📄 Detailed documentation and active community
  • 🔍 Search through the web or supported integrations in an instant
  • 🏴󠁧󠁢󠁮󠁩󠁲󠁿 Monitor your application with a built-in status system
  • 🦞 Comprehensive built-in icon picker with over 7000 icons
  • 🐳 Easy deployment with Docker, unRAID, and Synology
  • 🚀 Compatible with any major consumer hardware (x86, Raspberry Pi, old laptops, ...)




Widgets & Integrations Section
Homarr has a built-in collection of widgets and integrations, that connect to your applications and enable you to control them directly from the dashboard. Each widget and integration has a comprehensive documentation Homarr will integrate with the following applications:
📥 Torrent clients
📥 Usenet clients
📺 Media servers
📚 Media collection managers 🎞️ Media request managers
🚫 DNS ad-blockers
Other integrations
We're constantly adding new integrations and widgets, which will enhance your experience even further.



Preview Section




Installation Section
Since we are updating Homarr very frequently, we recommend reading our official installation guides:




Contribute Section Homarr is maintained by motivated developers in their free-time. We work for fun and learning on this project.
Hence, we're glad for all the help and support we can get. Although a donation is appreciated, there are other ways you can support us.

You can also support us by helping with translating the entire project to as many language as possible or contributing directly to the code or documentation.
Please read our Contribution Guidelines
All contributions, regardless of their size or scope, are welcome and highly appreciated! Thank you ❤️
Alt Covered by Argos Visual Testing

Serve Homarr (stack) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying homarr-stack.example.com to http://homarr:7575

Add this to your Caddyfile

homarr-stack.example.com {
	reverse_proxy http://homarr:7575
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:7575 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :7575
  • Stop the other service, or pick a different host port. In 7575:7575 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:7575. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, homarr can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 7575

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/homarr/configs (and the same for the other mapped folders)

Can't reach the Docker socket

homarr talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/ajnart/homarr:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Upstream project is archived

The developers have archived ajnart/homarr, so bugs and security issues won't be fixed.

  • It'll keep working for now, but consider the similar apps below for a maintained alternative.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Homarr (stack) is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Homarr (stack) needs bundled into one download. This template pulls ghcr.io/ajnart/homarr:latest, which Docker fetches once (about 374 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Homarr (stack)'s comes from the GitHub Container Registry, published by ajnart.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 7575:7575 means it's reachable on port 7575 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 7575:7575

Volumes

A volume is where Homarr (stack) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /app/data/configs from /portainer/Files/AppData/Config/homarr/configs on the host
  • /app/public/icons from /portainer/Files/AppData/Config/homarr/icons on the host
  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Homarr (stack) takes 2 of them, all with defaults you can leave alone or tweak:

  • TZ, defaults to Europe/Athens
  • DEFAULT_COLOR_SCHEME, defaults to dark

Restart policy

The restart policy here is unless-stopped, so Docker restarts Homarr (stack) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Homarr (stack) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container homarr. That's what you'll spot in the containers list and use in commands like docker logs homarr.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Homarr (stack) is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Homarr (stack) up. Add the template list to Portainer once, then deploying Homarr (stack) is a click rather than a wall of config.