aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md83
1 files changed, 81 insertions, 2 deletions
diff --git a/README.md b/README.md
index c98564a..12a2940 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,81 @@
1# homer 1# Homer
2A very simple static homepage for your server. 2A very simple static HOMepage for your servER.
3Add all your useful service, external links, notes... or anything.
4
5If 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, ...)
6
7![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
8
9**How to build / install it? Where is the webpack config?**
10There 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`.
11
12
13## configuration
14
15Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
16
17
18```yaml
19---
20# Homepage configuration
21# See https://fontawesome.com/v4.7.0/icons/ for icons options
22
23title: "Simple homepage"
24subtitle: "Homer"
25logo: "assets/homer.png"
26
27# Optional message
28message:
29 title: "Optional message!"
30 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque risus mi, tempus quis placerat ut, porta nec nulla. Vestibulum rhoncus ac ex sit amet fringilla. Nullam gravida purus diam, et dictum felis venenatis efficitur. Aenean ac eleifend lacus, in mollis lectus. Donec sodales, arcu et sollicitudin porttitor, tortor urna tempor ligula."
31
32# Optional navbar
33links:
34 - name: "ansible"
35 icon: "fa-github"
36 url: "https://github.com/xxxxx/ansible/"
37 - name: "Wiki"
38 icon: "fa-book"
39 url: "https://wiki.xxxxxx.com/"
40
41# Services
42# First level array represent a group.
43# Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
44services:
45 - name: "DevOps"
46 icon: "fa-code-fork"
47 items:
48 - name: "Jenkins"
49 logo: "/assets/tools/jenkins.png"
50 subtitle: "Continuous integration server"
51 tag: "CI"
52 url: "#"
53 - name: "RabbitMQ Management"
54 logo: "/assets/tools/rabbitmq.png"
55 subtitle: "Manage & monitor RabbitMQ server"
56 tag: "haproxy"
57 url: "#"
58 - name: "Monitoring"
59 icon: "fa-heartbeat"
60 items:
61 - name: "M/Monit"
62 logo: "/assets/tools/monit.png"
63 subtitle: "Monitor & manage all monit enabled hosts"
64 tag: "monit"
65 url: "#"
66 - name: "Grafana"
67 logo: "/assets/tools/grafana.png"
68 subtitle: "Metric analytics & dashboards"
69 url: "#"
70 - name: "Kibana"
71 logo: "/assets/tools/elastic.png"
72 subtitle: "Explore & visualize logs"
73 tag: "elk"
74 url: "#"
75 - name: "Website monitoring"
76 logo: "/assets/tools/pingdom.png"
77 subtitle: "Pingdom public reports overview"
78 tag: "CI"
79 url: "#"
80
81``` \ No newline at end of file