A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml
configuration file.
- Features
- Getting started
- Kubernetes Installation
- Configuration
- Theming
- Smart cards
- Tips & tricks
- Development
- Troubleshooting
- β‘οΈ 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.
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.
The configuration directory is bind mounted to make your dashboard easy to maintain.
Start the container with docker run
# 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 <your-UID>:<your-GID>
to the docker command to adjust it if necessary. Make sure this match the permissions of your assets directory.
or docker-compose
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: 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 default8080
to your port choice. -
IPV6_DISABLE
(default: 0) Set to1
to disable listening on IPv6.
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
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.
pnpm install
pnpm build
Then your dashboard is ready to use in the /dist
directory.