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 [![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
5 [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted)
7 A dead simple static **HOM**epage for your serv**ER** to keep your s
8 ervices on hand, from a simple `yaml` configuration file.
10 ## [Live demo](https://homer-demo.netlify.app).
11 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
14 - [Features](#features)
15 - [Getting started](#getting-started)
16 - [Configuration](#configuration)
18 - [Developement](#developement)
21 - [yaml](http://yaml.org/) file configuration
28 - `/` Start searching.
29 - `Escape` Stop searching.
30 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
31 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
36 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**.
41 docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
44 ### Using the release tarball (prebuilt, ready to use)
46 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.
49 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
52 cp config.yml.dist config.yml
53 npx serve # or python -m http.server 8010 or apache, nginx ...
59 # Using yarn (recommended)
68 Then your dashboard is ready to use in the `/dist` directory.
72 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.
76 # Homepage configuration
77 # See https://fontawesome.com/icons for icons options
79 title: "App dashboard"
81 logo: "assets/homer.png"
82 # Alternatively a fa icon can be provided:
83 # icon: "fas fa-skull-crossbones"
85 header: true # Set to false to hide the header
86 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:
89 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
91 # Here is the exaustive list of customization parameters
92 # However all value are optional and will fallback to default if not set.
93 # if you want to change only some of the colors, feel free to remove all unused key.
96 highlight-primary: "#3367d6"
97 highlight-secondary: "#4285f4"
98 highlight-hover: "#5a95f5"
100 card-background: "#ffffff"
102 text-header: "#424242"
103 text-title: "#303030"
104 text-subtitle: "#424242"
105 card-shadow: rgba(0, 0, 0, 0.1)
106 link-hover: "#363636"
108 highlight-primary: "#3367d6"
109 highlight-secondary: "#4285f4"
110 highlight-hover: "#5a95f5"
111 background: "#131313"
112 card-background: "#2b2b2b"
114 text-header: "#ffffff"
115 text-title: "#fafafa"
116 text-subtitle: "#f5f5f5"
117 card-shadow: rgba(0, 0, 0, 0.4)
118 link-hover: "#ffdd57"
122 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
124 title: "Optional message!"
125 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
128 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
131 icon: "fab fa-github"
132 url: "https://github.com/bastienwirtz/homer"
133 target: "_blank" # optional html tag target attribute
136 url: "https://github.com/bastienwirtz/homer"
139 # First level array represent a group.
140 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
142 - name: "Application"
143 icon: "fa fa-code-fork"
145 - name: "Awesome app"
146 logo: "assets/tools/sample.png"
147 # Alternatively a fa icon can be provided:
148 # icon: "fab fa-jenkins"
149 subtitle: "Bookmark example"
151 url: "https://www.reddit.com/r/selfhosted/"
152 target: "_blank" # optional html tag target attribute
153 - name: "Another one"
154 logo: "assets/tools/sample2.png"
155 subtitle: "Another application"
158 tagstyle: "is-success"
160 - name: "Other group"
161 icon: "fas fa-heartbeat"
163 - name: "Another app"
164 logo: "assets/tools/sample.png"
165 subtitle: "Another example"
167 url: "https://www.reddit.com/r/selfhosted/"
168 target: "_blank" # optionnal html a tag target attribute
171 If you choose to fetch message information from an endpoint, the output format should be:
176 "title": "Lorem ipsum 42",
177 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
181 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
182 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
186 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:
189 - `is-success` (green)
190 - `is-warning` (yellow)
193 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
198 - [ ] Add more themes.
199 - [ ] Add support for custom service card (add custom feature to some service / app link)
205 # Using yarn (recommended)
216 Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
217 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.
220 // `src/assets/themes/my-awesome-theme.scss`
221 body #app.theme-my-awesome-theme. { ... }
225 // `src/assets/app.scss`
227 @import "./themes/sui.scss";
229 @import "./themes/my-awesome-theme.scss";