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
  14 <p align="center">
  15  <strong>
  16    <a href="https://homer-demo.netlify.app">Demo</a>
  17   •
  18   <a href="https://gitter.im/homer-dashboard/community">Chat</a>
  19   •
  20   <a href="#getting-started">Getting started</a>
  21  </strong>
  22 </p>
  23 <p align="center">
  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
  28   alt="Gitter chat"
  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
  34   alt="Awesome"
  35   src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
  36 </p>
  37
  38 <p align="center">
  39  <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
  40 </p>
  41
  42 ## Table of Contents
  43
  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)
  51
  52 ## Features
  53
  54 - [yaml](http://yaml.org/) file configuration
  55 - Installable (pwa)
  56 - Search
  57 - Grouping
  58 - Theme customization
  59 - Offline health check
  60 - keyboard shortcuts:
  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.
  65
  66 ## Getting started
  67
  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**.
  69
  70 See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
  71
  72 ### Using docker
  73
  74 ```sh
  75 docker run -d \
  76   -p 8080:8080 \
  77   -v </your/local/assets/>:/www/assets \
  78   --restart=always \
  79   b4bz/homer:latest
  80 ```
  81
  82 Environment variables:
  83
  84 * **`INIT_ASSETS`** (default: `1`)
  85 Install exemple configuration file & assets (favicons, ...) to help you get started.
  86
  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`).
  89
  90
  91 ### Using docker-compose
  92
  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):
  95
  96 ```yaml
  97 volumes:
  98   - /your/local/assets/:/www/assets
  99 ports:
 100   - 8080:8080
 101 ```
 102
 103 Then launch the container:
 104
 105 ```sh
 106 cd /path/to/docker-compose.yml/
 107 docker-compose up -d
 108 ```
 109
 110 ### Using the release tarball (prebuilt, ready to use)
 111
 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.
 113
 114 ```sh
 115 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 116 unzip homer.zip
 117 cd homer
 118 cp assets/config.yml.dist assets/config.yml
 119 npx serve # or python -m http.server 8010 or apache, nginx ...
 120 ```
 121
 122 ### Build manually
 123
 124 ```sh
 125 # Using yarn (recommended)
 126 yarn install
 127 yarn build
 128
 129 # **OR** Using npm
 130 npm install
 131 npm run build
 132 ```
 133
 134 Then your dashboard is ready to use in the `/dist` directory.