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 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, ...)
   5
   6 ![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
   7
   8 **How to build / install it? Where is the webpack config?**
   9 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`.
  10
  11
  12 ## configuration
  13
  14 Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
  15
  16
  17 ```yaml
  18 ---
  19 # Homepage configuration
  20 # See https://fontawesome.com/icons for icons options
  21
  22 title: "Simple homepage"
  23 subtitle: "Homer"
  24 logo: "assets/homer.png"
  25 # Alternatively a fa icon can be provided:
  26 # icon: "fas fa-skull-crossbones"
  27
  28 # Optional message
  29 message:
  30   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
  31   style: "is-warning"
  32   title: "Optional message!"
  33   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."
  34
  35 # Optional navbar
  36 links:
  37   - name: "ansible"
  38     icon: "fa-github"
  39     url: "https://github.com/xxxxx/ansible/"
  40     target: '_blank' # optionnal html a tag target attribute
  41   - name: "Wiki"
  42     icon: "fa-book"
  43     url: "https://wiki.xxxxxx.com/"
  44
  45 # Services
  46 # First level array represent a group.
  47 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
  48 services:
  49   - name: "DevOps"
  50     icon: "fa-code-fork"
  51     items:
  52       - name: "Jenkins"
  53         logo: "/assets/tools/jenkins.png"
  54         # Alternatively a fa icon can be provided:
  55         # icon: "fab fa-jenkins"
  56         subtitle: "Continuous integration server"
  57         tag: "CI"
  58         url: "#"
  59         target: '_blank' # optionnal html a tag target attribute
  60       - name: "RabbitMQ Management"
  61         logo: "/assets/tools/rabbitmq.png"
  62         subtitle: "Manage & monitor RabbitMQ server"
  63         tag: "haproxy"
  64         # Optional tagstyle
  65         tagstyle: "is-success"
  66         url: "#"
  67   - name: "Monitoring"
  68     icon: "fa-heartbeat"
  69     items:
  70       - name: "M/Monit"
  71         logo: "/assets/tools/monit.png"
  72         subtitle: "Monitor & manage all monit enabled hosts"
  73         tag: "monit"
  74         url: "#"
  75       - name: "Grafana"
  76         logo: "/assets/tools/grafana.png"
  77         subtitle: "Metric analytics & dashboards"
  78         url: "#"
  79       - name: "Kibana"
  80         logo: "/assets/tools/elastic.png"
  81         subtitle: "Explore & visualize logs"
  82         tag: "elk"
  83         url: "#"
  84       - name: "Website monitoring"
  85         logo: "/assets/tools/pingdom.png"
  86         subtitle: "Pingdom public reports overview"
  87         tag: "CI"
  88         url: "#"
  89
  90 ```
  91
  92 If you choose to fetch message information from an endpoint, the output format should be:
  93
  94 ```json
  95 {
  96         "style": null,
  97         "title": "Lorem ipsum 42",
  98         "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
  99 }
 100 ```
 101
 102 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
 103 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar)