# Homer
-A very simple static HOMepage for your servER.
-Add all your useful service, external links, notes... or anything.
+A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
-If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunneling, ...)
+If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunnel, ...)
![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
**How to build / install it? Where is the webpack config?**
There is no build system (😱), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`.
-
+
## configuration
```yaml
---
# Homepage configuration
-# See https://fontawesome.com/v4.7.0/icons/ for icons options
+# See https://fontawesome.com/icons for icons options
title: "Simple homepage"
subtitle: "Homer"
logo: "assets/homer.png"
+# Alternatively a fa icon can be provided:
+# icon: "fas fa-skull-crossbones"
# Optional message
message:
# Services
# First level array represent a group.
-# Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
+# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
services:
- name: "DevOps"
icon: "fa-code-fork"
items:
- name: "Jenkins"
logo: "/assets/tools/jenkins.png"
+ # Alternatively a fa icon can be provided:
+ # icon: "fab fa-jenkins"
subtitle: "Continuous integration server"
tag: "CI"
url: "#"
logo: "/assets/tools/rabbitmq.png"
subtitle: "Manage & monitor RabbitMQ server"
tag: "haproxy"
+ # Optional tagstyle
+ tagstyle: "is-success"
url: "#"
- name: "Monitoring"
icon: "fa-heartbeat"
tag: "CI"
url: "#"
-```
\ No newline at end of file
+```