docs/index.md

   1 <div class="centered">
   2   <img width="180"
   3        alt="Homer's donut"
   4        src="images/logo.png" />
   5   <h1>Homer</h1>
   6 </div>
   7
   8 <p class="centered">
   9   A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep
  10   your services on hand, from a simple <code>yaml</code> configuration file.
  11 </p>
  12
  13 <div class="centered">
  14   <a href="https://opensource.org/licenses/Apache-2.0">
  15     <img alt="License: Apache 2"
  16          src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" />
  17   </a>
  18   <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
  19     <img alt="Gitter chat"
  20          src="https://badges.gitter.im/homer-dashboard/community.svg" />
  21   </a>
  22   <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip">
  23     <img alt="Download homer static build"
  24          src="https://img.shields.io/badge/Download-homer.zip-orange" />
  25   </a>
  26   <a href="https://github.com/awesome-selfhosted/awesome-selfhosted">
  27     <img alt="Awesome"
  28          src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" />
  29   </a>
  30 </div>
  31
  32 ## Demo
  33
  34 [![Demo](images/screenshot.png)](https://homer-demo.netlify.app)
  35 [Check out the demo!](https://homer-demo.netlify.app)
  36
  37 ## Features
  38
  39 - [yaml](http://yaml.org/) file configuration
  40 - Installable (pwa)
  41 - Search
  42 - Grouping
  43 - Theme customization
  44 - Offline health check
  45 - keyboard shortcuts:
  46   - `/` Start searching.
  47   - `Escape` Stop searching.
  48   - `Enter` Open the first matching result (respects the bookmark's `_target` property).
  49   - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
  50
  51 ## Getting started
  52
  53 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**.
  54
  55 See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
  56
  57 ### Using docker
  58
  59 To launch container:
  60
  61 ```sh
  62 docker run -d \
  63   -p 8080:8080 \
  64   -v </your/local/assets/>:/www/assets \
  65   --restart=always \
  66   b4bz/homer:latest
  67 ```
  68
  69 Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`).
  70
  71 ### Using docker-compose
  72
  73 The `docker-compose.yml` file must be edited to match your needs.
  74 Set the port and volume (equivalent to `-p` and `-v` arguments):
  75
  76 ```yaml
  77 volumes:
  78   - /your/local/assets/:/www/assets
  79 ports:
  80   - 8080:8080
  81 ```
  82
  83 To launch container:
  84
  85 ```sh
  86 cd /path/to/docker-compose.yml
  87 docker-compose up -d
  88 ```
  89
  90 Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`:
  91
  92 ```yaml
  93 environment:
  94   - UID=1000
  95   - GID=1000
  96 ```
  97
  98 ### Using the release tarball (prebuilt, ready to use)
  99
 100 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.
 101
 102 ```sh
 103 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 104 unzip homer.zip
 105 cd homer
 106 cp assets/config.yml.dist assets/config.yml
 107 npx serve # or python -m http.server 8010 or apache, nginx ...
 108 ```
 109
 110 ### Build manually
 111
 112 ```sh
 113 # Using yarn (recommended)
 114 yarn install
 115 yarn build
 116
 117 # **OR** Using npm
 118 npm install
 119 npm run build
 120 ```
 121
 122 Then your dashboard is ready to use in the `/dist` directory.