k8s 中文文档


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


  1. ``` shell
  2. docker run -d \
  3.   -p 8080:8080 \
  4.   -v </your/local/assets/>:/www/assets \
  5.   --restart=always \
  6.   b4bz/homer:latest
  7. ```

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.

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:

  1. ``` shell
  2. cd /path/to/docker-compose.yml/
  3. docker-compose up -d
  4. ```

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.

  1. ``` shell
  2. wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
  3. unzip homer.zip
  4. cd homer
  5. cp assets/config.yml.dist assets/config.yml
  6. npx serve # or python -m http.server 8010 or apache, nginx ...
  7. ```

Using Helm


Thanks to @djjudas21 charts :

  1. ``` shell
  2. helm repo add djjudas21 https://djjudas21.github.io/charts/
  3. helm repo update djjudas21

  5. # install with all defaults
  6. helm install homer djjudas21/homer

  8. # install with customisations
  9. wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml
  10. # edit values.yaml
  11. helm install homer djjudas21/homer -f values.yaml
  12. ```

Build manually


  1. ``` shell
  2. # Using yarn (recommended)
  3. yarn install
  4. yarn build

  6. # **OR** Using npm
  7. npm install
  8. npm run build
  9. ```

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