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 # Optional: Use external configuration file.
89 # Using this will ignore remaining config in this file
90 # externalConfig: https://example.com/server-luci/config.yaml
92 title: "App dashboard"
94 logo: "assets/homer.png"
95 # Alternatively a fa icon can be provided:
96 # icon: "fas fa-skull-crossbones"
98 header: true # Set to false to hide the header
99 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.
102 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
104 # Here is the exaustive list of customization parameters
105 # However all value are optional and will fallback to default if not set.
106 # if you want to change only some of the colors, feel free to remove all unused key.
109 highlight-primary: "#3367d6"
110 highlight-secondary: "#4285f4"
111 highlight-hover: "#5a95f5"
112 background: "#f5f5f5"
113 card-background: "#ffffff"
115 text-header: "#424242"
116 text-title: "#303030"
117 text-subtitle: "#424242"
118 card-shadow: rgba(0, 0, 0, 0.1)
119 link-hover: "#363636"
121 highlight-primary: "#3367d6"
122 highlight-secondary: "#4285f4"
123 highlight-hover: "#5a95f5"
124 background: "#131313"
125 card-background: "#2b2b2b"
127 text-header: "#ffffff"
128 text-title: "#fafafa"
129 text-subtitle: "#f5f5f5"
130 card-shadow: rgba(0, 0, 0, 0.4)
131 link-hover: "#ffdd57"
135 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
137 title: "Optional message!"
138 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
141 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
144 icon: "fab fa-github"
145 url: "https://github.com/bastienwirtz/homer"
146 target: "_blank" # optional html tag target attribute
149 url: "https://github.com/bastienwirtz/homer"
152 # First level array represent a group.
153 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
155 - name: "Application"
156 icon: "fa fa-code-fork"
158 - name: "Awesome app"
159 logo: "assets/tools/sample.png"
160 # Alternatively a fa icon can be provided:
161 # icon: "fab fa-jenkins"
162 subtitle: "Bookmark example"
164 url: "https://www.reddit.com/r/selfhosted/"
165 target: "_blank" # optional html tag target attribute
166 - name: "Another one"
167 logo: "assets/tools/sample2.png"
168 subtitle: "Another application"
171 tagstyle: "is-success"
173 - name: "Other group"
174 icon: "fas fa-heartbeat"
176 - name: "Another app"
177 logo: "assets/tools/sample.png"
178 subtitle: "Another example"
180 url: "https://www.reddit.com/r/selfhosted/"
181 target: "_blank" # optionnal html a tag target attribute
184 If you choose to fetch message information from an endpoint, the output format should be:
189 "title": "Lorem ipsum 42",
190 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
194 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
195 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
199 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:
202 - `is-success` (green)
203 - `is-warning` (yellow)
206 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
211 - [ ] Add more themes.
212 - [ ] Add support for custom service card (add custom feature to some service / app link)
218 # Using yarn (recommended)
229 Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
230 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.
233 // `src/assets/themes/my-awesome-theme.scss`
234 body #app.theme-my-awesome-theme. { ... }
238 // `src/assets/app.scss`
240 @import "./themes/sui.scss";
242 @import "./themes/my-awesome-theme.scss";