README.md

   1 # Homer
   2 A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
   3
   4 **Check out the live demo [here](https://homer-demo.netlify.com/).**
   5
   6 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, ...)
   7
   8 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
   9
  10 ## Roadmap
  11
  12 - [ ] Colors / theme customization
  13 - [ ] Enable PWA support (making possible to "install" - add to homescreen - it)
  14 - [ ] Improve maintenability (external library import & service workers cached file list.)
  15
  16 ## Installation
  17
  18 ### Using docker
  19
  20 ```sh
  21 sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
  22 ```
  23
  24 ### Manually
  25
  26 **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`.
  27
  28
  29 ## Configuration
  30
  31 Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
  32
  33
  34 ```yaml
  35 ---
  36 # Homepage configuration
  37 # See https://fontawesome.com/icons for icons options
  38
  39 title: "Simple homepage"
  40 subtitle: "Homer"
  41 logo: "assets/homer.png"
  42 # Alternatively a fa icon can be provided:
  43 # icon: "fas fa-skull-crossbones"
  44 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:
  45
  46 # Optional message
  47 message:
  48   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
  49   style: "is-warning"
  50   title: "Optional message!"
  51   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."
  52
  53 # Optional navbar
  54 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
  55 links:
  56   - name: "ansible"
  57     icon: "fa-github"
  58     url: "https://github.com/xxxxx/ansible/"
  59     target: '_blank' # optionnal html a tag target attribute
  60   - name: "Wiki"
  61     icon: "fa-book"
  62     url: "https://wiki.xxxxxx.com/"
  63
  64 # Services
  65 # First level array represent a group.
  66 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
  67 services:
  68   - name: "DevOps"
  69     icon: "fa-code-fork"
  70     items:
  71       - name: "Jenkins"
  72         logo: "/assets/tools/jenkins.png"
  73         # Alternatively a fa icon can be provided:
  74         # icon: "fab fa-jenkins"
  75         subtitle: "Continuous integration server"
  76         tag: "CI"
  77         url: "#"
  78         target: '_blank' # optionnal html a tag target attribute
  79       - name: "RabbitMQ Management"
  80         logo: "/assets/tools/rabbitmq.png"
  81         subtitle: "Manage & monitor RabbitMQ server"
  82         tag: "haproxy"
  83         # Optional tagstyle
  84         tagstyle: "is-success"
  85         url: "#"
  86   - name: "Monitoring"
  87     icon: "fa-heartbeat"
  88     items:
  89       - name: "M/Monit"
  90         logo: "/assets/tools/monit.png"
  91         subtitle: "Monitor & manage all monit enabled hosts"
  92         tag: "monit"
  93         url: "#"
  94       - name: "Grafana"
  95         logo: "/assets/tools/grafana.png"
  96         subtitle: "Metric analytics & dashboards"
  97         url: "#"
  98       - name: "Kibana"
  99         logo: "/assets/tools/elastic.png"
 100         subtitle: "Explore & visualize logs"
 101         tag: "elk"
 102         url: "#"
 103       - name: "Website monitoring"
 104         logo: "/assets/tools/pingdom.png"
 105         subtitle: "Pingdom public reports overview"
 106         tag: "CI"
 107         url: "#"
 108
 109 ```
 110
 111 If you choose to fetch message information from an endpoint, the output format should be:
 112
 113 ```json
 114 {
 115         "style": null,
 116         "title": "Lorem ipsum 42",
 117         "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
 118 }
 119 ```
 120
 121 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
 122 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).