README.md

   1 <h1 align="center">
   2  <img
   3   width="180"
   4   alt="Homer's donut"
   5   src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
   6     <br/>
   7     Homer
   8 </h1>
   9
  10 <h4 align="center">
  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.
  12 </h4>
  13 <p align="center">
  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>
  15 <p>
  16 <p align="center">
  17  <strong>
  18    <a href="https://homer-demo.netlify.app">Demo</a>
  19   •
  20   <a href="https://gitter.im/homer-dashboard/community">Chat</a>
  21   •
  22   <a href="#getting-started">Getting started</a>
  23  </strong>
  24 </p>
  25 <p align="center">
  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
  30   alt="Gitter chat"
  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
  36   alt="speed-blazing"
  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
  39   alt="Awesome"
  40   src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
  41 </p>
  42
  43 <p align="center">
  44  <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
  45 </p>
  46
  47 ## Table of Contents
  48
  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)
  56
  57 ## Features
  58
  59 - [yaml](http://yaml.org/) file configuration
  60 - Installable (pwa)
  61 - Search
  62 - Grouping
  63 - Theme customization
  64 - Offline health check
  65 - keyboard shortcuts:
  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.
  70
  71 ## Getting started
  72
  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.
  74
  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**.
  76
  77 ### Using docker
  78
  79 ```sh
  80 docker run -d \
  81   -p 8080:8080 \
  82   -v </your/local/assets/>:/www/assets \
  83   --restart=always \
  84   b4bz/homer:latest
  85 ```
  86
  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.
  88
  89 **Environment variables:**
  90
  91 * **`INIT_ASSETS`** (default: `1`)
  92 Install example configuration file & assets (favicons, ...) to help you get started.
  93
  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`).
  96
  97 * **`PORT`** (default: `8080`)
  98 If you would like to change internal port of Homer from default `8080` to your port choice.
  99
 100 * **`IPV6_DISABLE`** (default: 0)
 101 Set to `1` to disable listening on IPv6.
 102
 103 #### With docker-compose
 104
 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).
 106
 107 Then launch the container:
 108
 109 ```sh
 110 cd /path/to/docker-compose.yml/
 111 docker-compose up -d
 112 ```
 113
 114 ### Using the release tarball (prebuilt, ready to use)
 115
 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.
 117
 118 ```sh
 119 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 120 unzip homer.zip
 121 cd homer
 122 cp assets/config.yml.dist assets/config.yml
 123 npx serve # or python -m http.server 8010 or apache, nginx ...
 124 ```
 125
 126 ### Using Helm
 127
 128 Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer):
 129
 130 ```sh
 131 helm repo add djjudas21 https://djjudas21.github.io/charts/
 132 helm repo update djjudas21
 133
 134 # install with all defaults
 135 helm install homer djjudas21/homer
 136
 137 # install with customisations
 138 wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml
 139 # edit values.yaml
 140 helm install homer djjudas21/homer -f values.yaml
 141 ```
 142
 143 ### Build manually
 144
 145 ```sh
 146 # Using yarn (recommended)
 147 yarn install
 148 yarn build
 149
 150 # **OR** Using npm
 151 npm install
 152 npm run build
 153 ```
 154
 155 Then your dashboard is ready to use in the `/dist` directory.