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](https://badges.gitter.im/homer-dashboard/community.svg)](https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
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)
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.
11 ## [Live demo](https://homer-demo.netlify.app) • [Chat](https://gitter.im/homer-dashboard/community)
12 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
15 - [Features](#features)
16 - [Getting started](#getting-started)
17 - [Configuration](#configuration)
19 - [Developement](#developement)
22 - [yaml](http://yaml.org/) file configuration
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.
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**.
42 docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
45 As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory.
46 You can initialise your assets directory with the content provided in this repository
48 cp -r /public/assets/* /your/local/assets/
51 **Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
53 ### Using the release tarball (prebuilt, ready to use)
55 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.
58 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
61 cp config.yml.dist config.yml
62 npx serve # or python -m http.server 8010 or apache, nginx ...
68 # Using yarn (recommended)
77 Then your dashboard is ready to use in the `/dist` directory.
81 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.
85 # Homepage configuration
86 # See https://fontawesome.com/icons for icons options
88 title: "App dashboard"
90 logo: "assets/homer.png"
91 # Alternatively a fa icon can be provided:
92 # icon: "fas fa-skull-crossbones"
94 header: true # Set to false to hide the header
95 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:
98 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
100 # Here is the exaustive list of customization parameters
101 # However all value are optional and will fallback to default if not set.
102 # if you want to change only some of the colors, feel free to remove all unused key.
105 highlight-primary: "#3367d6"
106 highlight-secondary: "#4285f4"
107 highlight-hover: "#5a95f5"
108 background: "#f5f5f5"
109 card-background: "#ffffff"
111 text-header: "#424242"
112 text-title: "#303030"
113 text-subtitle: "#424242"
114 card-shadow: rgba(0, 0, 0, 0.1)
115 link-hover: "#363636"
117 highlight-primary: "#3367d6"
118 highlight-secondary: "#4285f4"
119 highlight-hover: "#5a95f5"
120 background: "#131313"
121 card-background: "#2b2b2b"
123 text-header: "#ffffff"
124 text-title: "#fafafa"
125 text-subtitle: "#f5f5f5"
126 card-shadow: rgba(0, 0, 0, 0.4)
127 link-hover: "#ffdd57"
131 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
133 title: "Optional message!"
134 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
137 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
140 icon: "fab fa-github"
141 url: "https://github.com/bastienwirtz/homer"
142 target: "_blank" # optional html tag target attribute
145 url: "https://github.com/bastienwirtz/homer"
148 # First level array represent a group.
149 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
151 - name: "Application"
152 icon: "fa fa-code-fork"
154 - name: "Awesome app"
155 logo: "assets/tools/sample.png"
156 # Alternatively a fa icon can be provided:
157 # icon: "fab fa-jenkins"
158 subtitle: "Bookmark example"
160 url: "https://www.reddit.com/r/selfhosted/"
161 target: "_blank" # optional html tag target attribute
162 - name: "Another one"
163 logo: "assets/tools/sample2.png"
164 subtitle: "Another application"
167 tagstyle: "is-success"
169 - name: "Other group"
170 icon: "fas fa-heartbeat"
172 - name: "Another app"
173 logo: "assets/tools/sample.png"
174 subtitle: "Another example"
176 url: "https://www.reddit.com/r/selfhosted/"
177 target: "_blank" # optionnal html a tag target attribute
180 If you choose to fetch message information from an endpoint, the output format should be:
185 "title": "Lorem ipsum 42",
186 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
190 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
191 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
195 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:
198 - `is-success` (green)
199 - `is-warning` (yellow)
202 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
207 - [ ] Add more themes.
208 - [ ] Add support for custom service card (add custom feature to some service / app link)
214 # Using yarn (recommended)
225 Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
226 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.
229 // `src/assets/themes/my-awesome-theme.scss`
230 body #app.theme-my-awesome-theme. { ... }
234 // `src/assets/app.scss`
236 @import "./themes/sui.scss";
238 @import "./themes/my-awesome-theme.scss";