README.md

   1 <h1 align="center">
   2  <img
   3   width="180"
   4   alt="Homer's donut"
   5   src="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="docs/images/screenshot.png" width="100%">
  40 </p>
  41
  42 ## Table of Contents
  43
  44 - [Features](#features)
  45 - [Getting started](#getting-started)
  46 - [Configuration](https://bastienwirtz.github.io/homer/configuration)
  47 - [Custom services](https://bastienwirtz.github.io/homer/custom_services)
  48 - [Tips & tricks](https://bastienwirtz.github.io/homer/tips_and_tricks)
  49 - [Development](https://bastienwirtz.github.io/homer/development)
  50 - [Troubleshooting](https://bastienwirtz.github.io/homer/troubleshooting)
  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 ### Using Docker
  69
  70 The fastest and recommended way to get your Homer instance up and running is
  71 with Docker. The Docker image comes with a web server built-in so that all you
  72 need to worry about is your config file.
  73
  74 Internally, the Docker image looks for the assets in the `/www/assets` directory
  75 so you can bind a volume from your host machine to that directory in order to
  76 modify and persist the configuration files. The web server serves the dashboard
  77 on port 8080, but using a port binding will let you expose that to whatever
  78 external port you like.
  79
  80 #### docker
  81
  82 To launch container:
  83
  84 ```sh
  85 docker run -d \
  86   -p 8080:8080 \
  87   -v </your/local/assets>:/www/assets \
  88   --restart=always \
  89   b4bz/homer:latest
  90 ```
  91
  92 Use `UID` and/or `GID` env var to change the assets owner:
  93
  94 ```sh
  95 docker run -d \
  96   -p 8080:8080 \
  97   -v </your/local/assets>:/www/assets \
  98   -e "UID=1000" -e "GID=1000" \
  99   --restart=always \
 100   b4bz/homer:latest
 101 ```
 102
 103 #### docker-compose
 104
 105 It is recommended to use docker-compose to manage your Docker containers, and
 106 below you can find a simple compose yaml file. Copy the contents into a
 107 `docker-compose.yaml` and modify the volume binding to your desired directory to
 108 get started:
 109
 110 ```yaml
 111 version: '3.3'
 112 services:
 113   homer:
 114     restart: always
 115     volumes:
 116       - /your/local/assets:/www/assets
 117     ports:
 118       - 8080:8080
 119     image: b4bz/homer
 120 ```
 121
 122 To launch container:
 123
 124 ```sh
 125 cd /path/to/docker-compose.yml
 126 docker-compose up -d
 127 ```
 128
 129 Use `UID` and/or `GID` env var to change the assets owner:
 130
 131 ```yaml
 132 version: '3.3'
 133 services:
 134   homer:
 135     restart: always
 136     volumes:
 137       - /your/local/assets:/www/assets
 138     ports:
 139       - 8080:8080
 140     environment:
 141       - UID=1000
 142       - GID=1000
 143     image: b4bz/homer
 144 ```
 145
 146 ### Shipping your own web server
 147
 148 #### Prebuilt release tarball
 149
 150 Download and extract the latest release (`homer.zip`) from the [release page]
 151 (https://github.com/bastienwirtz/homer/releases), rename the
 152 `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a web
 153 server.
 154
 155 ```sh
 156 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 157 unzip homer.zip
 158 cd homer
 159 cp assets/config.yml.dist assets/config.yml
 160 npx serve # or python -m http.server 8010 or apache, nginx ...
 161 ```
 162
 163 #### Building from source
 164
 165 ```sh
 166 # Using yarn (recommended)
 167 yarn install
 168 yarn build
 169
 170 # **OR** Using npm
 171 npm install
 172 npm run build
 173 ```
 174
 175 Then your dashboard is ready to use in the `/dist` directory.