+0
Daily
11,721
stars
927
forks
56
watchers
505
prs
594
issues
72
releases
README
Homer
A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.
Demo
•
Docker Hub
•
Get started
Highlights
- ⚡️ Lightweight & Fast
- 🥱 Low / No maintenance
- 📄 Simple yaml file configuration
- ➕ Installable (pwa)
- 🧠 Smart cards
- 🔍️ Fuzzy search
- 📂 Multi pages & item grouping
- 🎨 Theme customization
- ⌨️ keyboard shortcuts:
- / Start searching.
- Escape Stop searching.
- Enter Open the first matching result (respects the bookmark's _target property).
- Alt (or Option) + Enter Open the first matching result in a new tab.
Table of Contents
- Getting started
- Kubernetes Installation
- Configuration
- Theming
- Smart cards
- Tips & tricks
- Development
- Troubleshooting
Get started
Homer is a full static html/js dashboard, based on a simple yaml configuration file. See documentation for information about the configuration (assets/config.yml) options.
It's meant to be served by an HTTP server, it will not work if you open the index.html directly over file:// protocol.
Using docker
The configuration directory is bind mounted to make your dashboard easy to maintain.
Start the container with docker run
sh
Make sure your local config directory exists
docker run -d \
--name homer \
-p 8080:8080 \
--mount type=bind,source="/path/to/config/dir",target=/www/assets \
--restart=unless-stopped \
b4bz/homer:latest
[!NOTE]
The container will run using a user uid and gid 1000 by default, add --user : to the docker command to adjust it if necessary. Make sure this match the permissions of your assets directory.
or docker-compose
yaml
services:
homer:
image: b4bz/homer
container_name: homer
volumes:
- /path/to/config/dir:/www/assets Make sure your local config directory exists
ports:
- 8080:8080
user: 1000:1000 default
environment:
- INIT_ASSETS=1 default, requires the config directory to be writable for the container user (see user option)
restart: unless-stopped
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: ), set this to the subfolder path (ex /homer).
- PORT (default: 8080)
If you would like to change internal port of Homer from default 8080 to your port choice.
- IPV6_DISABLE (default: 0)
Set to 1 to disable listening on IPv6.
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.
sh
wget https://github.com/homer-dashboard/homer/releases/latest/download/homer.zip
unzip homer.zip -d homer
cd homer
cp assets/config.yml.dist assets/config.yml
pnpx http-server or python -m http.server 8010 or any web server.
Build manually
sh
pnpm instTop issues
#688Cant get any of the custom services to work11 comments · 2023-08-21#1018External favicons URLs7 comments · 2026-02-01#465Feature request: custom service from JSON (with mapping like in messages)7 comments · 2022-06-08#987Unknown variable dynamic import when trying to add openhab6 comments · 2025-09-29#867Message content from local json not visible unless page is refrehed6 comments · 2025-02-05#746Add ability to route relative to the current URL / browser location API6 comments · 2024-02-15#631Adguard Home Stats Unknown Status 403 5 comments · 2023-04-22#571Portainer type not show containers information5 comments · 2022-12-12
Discussions
Latest release
v26.11.3 v26.11.3 2026-11-14What's Changed Main changes feat(services): add Beszel smart card integration by @brhnshn in https://github.com/homer-dashboard/homer/pull/1087 feat(services): add Memos smart card integration by @brhnshn in https://github.com/homer-dashboard/homer/pull/1088 fix(Linkding): respect the configured link target by @yuxino in https://github.com/homer-dashboard/homer/pull/1103 fix: actually remove the search keydown listener on unmount by @Lakshya77089 in https://github.com/homer-dashboard/homer/pull/1049 feat: move Homer to it's own organization by @bastienwirtz in https://github.com/homer-da