Portainer Templates logo

Portainer Templates

Homer Homer

Container

OtherTools

A dead simple static HOMepage for your servER to keep your s ervices on hand, from a simple yaml configuration file.

Image details

Pulls: 44.0M
Architecture: amd64, arm64, arm/v7, arm/v6, arm, arm64/v8
Image size: 7 MB
Latest: v26.4.2
User: b4bz
Created: Feb 27, 2020
Updated: 3 months ago
Status: active

Source details

Repo: bastienwirtz/homer
Stars: 11.6k
Forks: 921
Language: Vue
License: Apache-2.0
Latest: v26.4.2 · 3 months ago
Updated: 8 days ago
Website: homer-demo.netlify.app/

Configuration

Type
Container
Platform
linux
Image
b4bz/homer:latest
Ports
8902:8080/tcp
Volumes
/www/assets : /portainer/Files/AppData/Config/Homer/assets/www/config.yml : /portainer/Files/AppData/Config/Homer
Env vars
PUID=1000PGID=100
Restart
unless-stopped

Template by Qballjos

Notes

This container requires a yml file within the config volume. See the documentation here https://github.com/bastienwirtz/homer

Standalone Install

Select an install method, to see config/commands for deploying Homer

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 Homer, fill in any config options, and hit Deploy

Template Import URL

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

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

Homer's donut
<br/>
Homer


A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. 


<a href="https://homer-demo.netlify.app">Demo</a>
• Chat • Getting started

License: Apache 2 Gitter chat Download homer static build Awesome


Table of Contents

Features

  • yaml file configuration
  • Installable (pwa)
  • Search
  • Grouping
  • Theme customization
  • Offline health check
  • keyboard shortcuts:
- / Start searching. - Escape Stop searching. - Enter Open the first matching result (respects the bookmark's _target property). - Alt/Option + Enter Open the first matching result in a new tab.

Getting started

Homer is a full static html/js dashboard, generated from the source in /src using webpack. It's meant to be served by an HTTP server, it will not work if you open dist/index.html directly over file:// protocol.
See documentation for information about the configuration (assets/config.yml) options.

Using docker

docker run -d \
  -p 8080:8080 \
  -v </your/local/assets/>:/www/assets \
  --restart=always \
  b4bz/homer:latest

Environment variables:
  • INIT_ASSETS (default: 1)
Install example configuration file & assets (favicons, ...) to help you get started.
  • SUBFOLDER (default: null)
If you would like to host Homer in a subfolder, (ex: http://my-domain/homer), set this to the subfolder path (ex /homer).

Using docker-compose

The docker-compose.yml file must be edited to match your needs. You probably want to set the port mapping and volume binding (equivalent to -p and -v arguments):
volumes:
  - /your/local/assets/:/www/assets
ports:
  - 8080:8080

Then launch the container:
cd /path/to/docker-compose.yml/
docker-compose up -d

Using the release tarball (prebuilt, ready to use)

Download and extract the latest release (homer.zip) from the release page, rename the assets/config.yml.dist file to assets/config.yml, and put it behind a web server.
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip
cd homer
cp assets/config.yml.dist assets/config.yml
npx serve # or python -m http.server 8010 or apache, nginx ...

Build manually

# Using yarn (recommended)
yarn install
yarn build

# **OR** Using npm
npm install
npm run build

Then your dashboard is ready to use in the /dist directory.

Serve Homer 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 homer.example.com to http://homer:8080

Add this to your Caddyfile

homer.example.com {
	reverse_proxy http://homer:8080
}

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 homer
  • 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:8902 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8902
  • Stop the other service, or pick a different host port. In 8902:8080 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:8902. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, homer can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8902

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:100 /portainer/Files/AppData/Config/Homer/assets (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull b4bz/homer: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, arm/v6, arm, arm64/v8
  • 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 homer --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

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

A single container

Homer runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Homer needs bundled into one download. This template pulls b4bz/homer:latest, which Docker fetches once (about 7 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. Homer's comes from Docker Hub, published by b4bz.

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. Newest right now is v26.4.2. 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, arm/v6, arm, arm64/v8, 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 8902:8080 means it's reachable on port 8902 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8902 in a browser. It opens:

  • 8902:8080, likely the web interface

Volumes

A volume is where Homer 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:

  • /www/assets from /portainer/Files/AppData/Config/Homer/assets on the host
  • /www/config.yml from /portainer/Files/AppData/Config/Homer on the host

Environment variables

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

  • PUID, defaults to 1000
  • PGID, defaults to 100

Restart policy

The restart policy here is unless-stopped, so Docker restarts Homer 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).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Homer 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 homer. That's what you'll spot in the containers list and use in commands like docker logs homer.

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

Homer is open source, released under the Apache-2.0 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 Homer up. Add the template list to Portainer once, then deploying Homer is a click rather than a wall of config.