Homer's donut
Homer

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

Buy Me A Coffee

Demo • Chat • Getting started

License: Apache 2 Gitter chat Download homer static build speed-blazing Awesome

## Table of Contents - [Features](#features) - [Getting started](#getting-started) - [Configuration](docs/configuration.md) - [Custom services](docs/customservices.md) - [Tips & tricks](docs/tips-and-tricks.md) - [Development](docs/development.md) - [Troubleshooting](docs/troubleshooting.md) ## Features - [yaml](http://yaml.org/) 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](docs/configuration.md) 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 ```sh docker run -d \ -p 8080:8080 \ -v :/www/assets \ --restart=always \ b4bz/homer:latest ``` The container will run using a user uid and gid 1000. Add `--user :` 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`](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: ```sh 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](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a web server. ```sh 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 ... ``` ### Using Helm Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer): ```sh helm repo add djjudas21 https://djjudas21.github.io/charts/ helm repo update djjudas21 # install with all defaults helm install homer djjudas21/homer # install with customisations wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml # edit values.yaml helm install homer djjudas21/homer -f values.yaml ``` ### Build manually ```sh # 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.