5 src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
11 A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
14 <a href="https://www.buymeacoffee.com/bastien" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
18 <a href="https://homer-demo.netlify.app">Demo</a>
20 <a href="https://gitter.im/homer-dashboard/community">Chat</a>
22 <a href="#getting-started">Getting started</a>
26 <a href="https://opensource.org/licenses/Apache-2.0"><img
27 alt="License: Apache 2"
28 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
29 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
31 src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
32 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
33 alt="Download homer static build"
34 src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
35 <a href="https://twitter.com/acdlite/status/974390255393505280"><img
37 src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-red"></a>
38 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
40 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
44 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
49 - [Features](#features)
50 - [Getting started](#getting-started)
51 - [Configuration](docs/configuration.md)
52 - [Custom services](docs/customservices.md)
53 - [Tips & tricks](docs/tips-and-tricks.md)
54 - [Development](docs/development.md)
55 - [Troubleshooting](docs/troubleshooting.md)
59 - [yaml](http://yaml.org/) file configuration
64 - Offline health check
66 - `/` Start searching.
67 - `Escape` Stop searching.
68 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
69 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
73 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.
75 It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**.
82 -v </your/local/assets/>:/www/assets \
87 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.
89 **Environment variables:**
91 * **`INIT_ASSETS`** (default: `1`)
92 Install example configuration file & assets (favicons, ...) to help you get started.
94 * **`SUBFOLDER`** (default: `null`)
95 If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`).
97 * **`PORT`** (default: `8080`)
98 If you would like to change internal port of Homer from default `8080` to your port choice.
100 * **`IPV6_DISABLE`** (default: 0)
101 Set to `1` to disable listening on IPv6.
103 #### With docker-compose
105 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).
107 Then launch the container:
110 cd /path/to/docker-compose.yml/
114 ### Using the release tarball (prebuilt, ready to use)
116 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.
119 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
122 cp assets/config.yml.dist assets/config.yml
123 npx serve # or python -m http.server 8010 or apache, nginx ...
128 Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer):
131 helm repo add djjudas21 https://djjudas21.github.io/charts/
132 helm repo update djjudas21
134 # install with all defaults
135 helm install homer djjudas21/homer
137 # install with customisations
138 wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml
140 helm install homer djjudas21/homer -f values.yaml
150 Then your dashboard is ready to use in the `/dist` directory.