README.md

   1 # Homer
   2 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
   3 [![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
   4 [![Gitter chat](https://img.shields.io/badge/chat-on_gitter-008080.svg?style=flat-square)](https://gitter.im/homer-dashboard)
   5 [![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
   6 [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted)
   7
   8 A dead simple static **HOM**epage for your serv**ER** to keep your s
   9 ervices on hand, from a simple `yaml` configuration file.
  10
  11 ## [Live demo](https://homer-demo.netlify.app)  • [Chat](https://gitter.im/homer-dashboard/)
  12 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
  13
  14 ## Table of Contents
  15 - [Features](#features)
  16 - [Getting started](#getting-started)
  17 - [Configuration](#configuration)
  18 - [Roadmap](#roadmap)
  19 - [Developement](#developement)
  20
  21 ## Features
  22 - [yaml](http://yaml.org/) file configuration
  23 - Installable (pwa)
  24 - Search
  25 - Grouping
  26 - Theme customization
  27 - Offline heathcheck
  28 - keyboard shortcuts:
  29   - `/` Start searching.
  30   - `Escape` Stop searching.
  31   - `Enter` Open the first matching result (respects the bookmark's `_target` property).
  32   - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
  33
  34
  35 ## Getting started
  36
  37 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**.
  38
  39 ### Using docker
  40
  41 ```sh
  42 docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
  43 ```
  44
  45 ### Using the release tarball (prebuilt, ready to use)
  46
  47 Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
  48
  49 ```sh
  50 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
  51 unzip homer.zip
  52 cd homer
  53 cp config.yml.dist config.yml
  54 npx serve # or python -m http.server 8010 or apache, nginx ...
  55 ```
  56
  57 ### Build manually
  58
  59 ```sh
  60 # Using yarn (recommended)
  61 yarn install
  62 yarn build
  63
  64 # **OR** Using npm
  65 npm install
  66 npm run build
  67 ```
  68
  69 Then your dashboard is ready to use in the `/dist` directory.
  70
  71 ## Configuration
  72
  73 Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format.
  74
  75 ```yaml
  76 ---
  77 # Homepage configuration
  78 # See https://fontawesome.com/icons for icons options
  79
  80 title: "App dashboard"
  81 subtitle: "Homer"
  82 logo: "assets/homer.png"
  83 # Alternatively a fa icon can be provided:
  84 # icon: "fas fa-skull-crossbones"
  85
  86 header: true # Set to false to hide the header
  87 footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.header:
  88
  89 # Optional theming
  90 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
  91
  92 # Here is the exaustive list of customization parameters
  93 # However all value are optional and will fallback to default if not set.
  94 # if you want to change only some of the colors, feel free to remove all unused key.
  95 colors:
  96   light:
  97     highlight-primary: "#3367d6"
  98     highlight-secondary: "#4285f4"
  99     highlight-hover: "#5a95f5"
 100     background: "#f5f5f5"
 101     card-background: "#ffffff"
 102     text: "#363636"
 103     text-header: "#424242"
 104     text-title: "#303030"
 105     text-subtitle: "#424242"
 106     card-shadow: rgba(0, 0, 0, 0.1)
 107     link-hover: "#363636"
 108   dark:
 109     highlight-primary: "#3367d6"
 110     highlight-secondary: "#4285f4"
 111     highlight-hover: "#5a95f5"
 112     background: "#131313"
 113     card-background: "#2b2b2b"
 114     text: "#eaeaea"
 115     text-header: "#ffffff"
 116     text-title: "#fafafa"
 117     text-subtitle: "#f5f5f5"
 118     card-shadow: rgba(0, 0, 0, 0.4)
 119     link-hover: "#ffdd57"
 120
 121 # Optional message
 122 message:
 123   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
 124   style: "is-warning"
 125   title: "Optional message!"
 126   content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
 127
 128 # Optional navbar
 129 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
 130 links:
 131   - name: "Link 1"
 132     icon: "fab fa-github"
 133     url: "https://github.com/bastienwirtz/homer"
 134     target: "_blank" # optional html tag target attribute
 135   - name: "link 2"
 136     icon: "fas fa-book"
 137     url: "https://github.com/bastienwirtz/homer"
 138
 139 # Services
 140 # First level array represent a group.
 141 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
 142 services:
 143   - name: "Application"
 144     icon: "fa fa-code-fork"
 145     items:
 146       - name: "Awesome app"
 147         logo: "assets/tools/sample.png"
 148         # Alternatively a fa icon can be provided:
 149         # icon: "fab fa-jenkins"
 150         subtitle: "Bookmark example"
 151         tag: "app"
 152         url: "https://www.reddit.com/r/selfhosted/"
 153         target: "_blank" # optional html tag target attribute
 154       - name: "Another one"
 155         logo: "assets/tools/sample2.png"
 156         subtitle: "Another application"
 157         tag: "app"
 158         # Optional tagstyle
 159         tagstyle: "is-success"
 160         url: "#"
 161   - name: "Other group"
 162     icon: "fas fa-heartbeat"
 163     items:
 164       - name: "Another app"
 165         logo: "assets/tools/sample.png"
 166         subtitle: "Another example"
 167         tag: "other"
 168         url: "https://www.reddit.com/r/selfhosted/"
 169         target: "_blank" # optionnal html a tag target attribute
 170 ```
 171
 172 If you choose to fetch message information from an endpoint, the output format should be:
 173
 174 ```json
 175 {
 176   "style": null,
 177   "title": "Lorem ipsum 42",
 178   "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
 179 }
 180 ```
 181
 182 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
 183 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
 184
 185 ### Style Options
 186
 187 Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
 188
 189 - `is-info` (blue)
 190 - `is-success` (green)
 191 - `is-warning` (yellow)
 192 - `is-danger` (red)
 193
 194 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
 195
 196
 197 ## Roadmap
 198
 199 - [ ] Add more themes.
 200 - [ ] Add support for custom service card (add custom feature to some service / app link)
 201
 202
 203 ## Development
 204
 205 ```sh
 206 # Using yarn (recommended)
 207 yarn install
 208 yarn serve
 209
 210 # **OR** Using npm
 211 npm install
 212 npm run serve
 213 ```
 214
 215 ### Themes
 216
 217 Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
 218 To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
 219
 220 ```scss
 221 // `src/assets/themes/my-awesome-theme.scss`
 222 body #app.theme-my-awesome-theme. { ... }
 223 ```
 224
 225 ```scss
 226 // `src/assets/app.scss`
 227 // Themes import
 228 @import "./themes/sui.scss";
 229 ...
 230 @import "./themes/my-awesome-theme.scss";
 231 ```