homer/README.md

Homer

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

Demo • Chat • Getting started

Table of Contents

• Features
• Getting started
• Configuration
• Custom services
• Tips & tricks
• Development
• Troubleshooting

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.