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