Table of Contents

• Features
• Getting started
• Kubernetes Installation
• Configuration
• Theming
• Smart cards
• Tips & tricks
• Development
• Troubleshooting

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/Option + Enter Open the first matching result in a new tab.

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

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

The container will run using a user uid and gid 1000. Add --user <your-UID>:<your-GID> to the docker command to adjust it. Make sure this match the ownership of your assets directory.

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).

• 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.

With docker-compose

A docker-compose.yml file is available as an example. It must be edited to match your needs. You probably want to adjust the port mapping and volume binding (equivalent to -p and -v arguments).

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 -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

pnpm install
pnpm build

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