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 - [Features](#features)
  44 - [Getting started](#getting-started)
  45 - [Configuration](docs/configuration.md)
  46 - [Tips & tricks](docs/tips-and-tricks.md)
  47 - [Roadmap](#roadmap)
  48 - [Development](docs/development.md)
  49
  50
  51 ## Features
  52 - [yaml](http://yaml.org/) file configuration
  53 - Installable (pwa)
  54 - Search
  55 - Grouping
  56 - Theme customization
  57 - Offline heathcheck
  58 - keyboard shortcuts:
  59   - `/` Start searching.
  60   - `Escape` Stop searching.
  61   - `Enter` Open the first matching result (respects the bookmark's `_target` property).
  62   - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
  63
  64
  65 ## Getting started
  66
  67 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**.
  68
  69 See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
  70
  71 ### Using docker
  72
  73 To launch container:
  74
  75 ```sh
  76 docker run -d \
  77   -p 8080:8080 \
  78   -v </your/local/assets/>:/www/assets \
  79   --restart=always \
  80   b4bz/homer:latest
  81 ```
  82
  83 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" [...]`).
  84
  85 ### Using docker-compose
  86
  87 The `docker-compose.yml` file must be edited to match your needs.
  88 Set the port and volume (equivalent to `-p` and `-v` arguments):
  89
  90 ```yaml
  91 volumes:
  92   - /your/local/assets/:/www/assets
  93 ports:
  94   - 8080:8080
  95 ```
  96
  97 To launch container:
  98
  99 ```sh
 100 cd /path/to/docker-compose.yml
 101 docker-compose up -d
 102 ```
 103
 104 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`:
 105
 106 ```yaml
 107 environment:
 108   - UID=1000
 109   - GID=1000
 110 ```
 111
 112 ### Using the release tarball (prebuilt, ready to use)
 113
 114 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 webserver.
 115
 116 ```sh
 117 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 118 unzip homer.zip
 119 cd homer
 120 cp assets/config.yml.dist assets/config.yml
 121 npx serve # or python -m http.server 8010 or apache, nginx ...
 122 ```
 123
 124 ### Build manually
 125
 126 ```sh
 127 # Using yarn (recommended)
 128 yarn install
 129 yarn build
 130
 131 # **OR** Using npm
 132 npm install
 133 npm run build
 134 ```
 135
 136 Then your dashboard is ready to use in the `/dist` directory.
 137
 138
 139 ## Roadmap
 140
 141 - [ ] Add new themes.
 142 - [ ] Add support for custom service card (add custom feature to some service / app link)