3 A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
5 **Check out the live demo [here](https://homer-demo.netlify.app).**
7 It supports keyboard shortcuts:
10 * `Escape` Stop searching.
11 * `Enter` Open the first matching result (respects the bookmark's `_target` property).
12 * `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
14 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, ...)
16 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
20 * [ ] Colors / theme customization
21 * [ ] Enable PWA support (making possible to "install" - add to homescreen - it)
22 * [ ] Improve maintainability (external library import & service workers cached file list.)
29 sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
34 **How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`.
38 Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
42 # Homepage configuration
43 # See https://fontawesome.com/icons for icons options
45 title: "Simple homepage"
47 logo: "assets/homer.png"
48 # Alternatively a fa icon can be provided:
49 # icon: "fas fa-skull-crossbones"
50 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:
54 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
56 title: "Optional message!"
57 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."
60 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
64 url: "https://github.com/xxxxx/ansible/"
65 target: '_blank' # optional html a tag target attribute
68 url: "https://wiki.xxxxxx.com/"
71 # First level array represent a group.
72 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
75 icon: "fa fa-code-fork"
78 logo: "/assets/tools/jenkins.png"
79 # Alternatively a fa icon can be provided:
80 # icon: "fab fa-jenkins"
81 subtitle: "Continuous integration server"
84 target: '_blank' # optional html a tag target attribute
85 - name: "RabbitMQ Management"
86 logo: "/assets/tools/rabbitmq.png"
87 subtitle: "Manage & monitor RabbitMQ server"
90 tagstyle: "is-success"
93 icon: "fas fa-heartbeat"
96 logo: "/assets/tools/monit.png"
97 subtitle: "Monitor & manage all monit enabled hosts"
101 logo: "/assets/tools/grafana.png"
102 subtitle: "Metric analytics & dashboards"
105 logo: "/assets/tools/elastic.png"
106 subtitle: "Explore & visualize logs"
109 - name: "Website monitoring"
110 logo: "/assets/tools/pingdom.png"
111 subtitle: "Pingdom public reports overview"
117 If you choose to fetch message information from an endpoint, the output format should be:
122 "title": "Lorem ipsum 42",
123 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
127 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
128 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).