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.
16 <a href="https://homer-demo.netlify.app">Demo</a>
18 <a href="https://gitter.im/homer-dashboard/community">Chat</a>
20 <a href="#getting-started">Getting started</a>
24 <a href="https://opensource.org/licenses/Apache-2.0"><img
25 alt="License: Apache 2"
26 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
27 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
29 src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
30 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
31 alt="Download homer static build"
32 src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
33 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
35 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
39 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
44 - [Features](#features)
45 - [Getting started](#getting-started)
46 - [Configuration](docs/configuration.md)
47 - [Custom services](docs/customservices.md)
48 - [Tips & tricks](docs/tips-and-tricks.md)
49 - [Development](docs/development.md)
50 - [Troubleshooting](docs/troubleshooting.md)
54 - [yaml](http://yaml.org/) file configuration
59 - Offline health check
61 - `/` Start searching.
62 - `Escape` Stop searching.
63 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
64 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
68 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**.
70 See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
77 -v </your/local/assets/>:/www/assets \
82 Environment variables:
84 * **`INIT_ASSETS`** (default: `1`)
85 Install example configuration file & assets (favicons, ...) to help you get started.
87 * **`SUBFOLDER`** (default: `null`)
88 If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`).
91 ### Using docker-compose
93 The `docker-compose.yml` file must be edited to match your needs.
94 You probably want to set the port mapping and volume binding (equivalent to `-p` and `-v` arguments):
98 - /your/local/assets/:/www/assets
103 Then launch the container:
106 cd /path/to/docker-compose.yml/
110 ### Using the release tarball (prebuilt, ready to use)
112 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.
115 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
118 cp assets/config.yml.dist assets/config.yml
119 npx serve # or python -m http.server 8010 or apache, nginx ...
125 # Using yarn (recommended)
134 Then your dashboard is ready to use in the `/dist` directory.