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   style: "is-warning"
  31   title: "Optional message!"
  32   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."
  33
  34 # Optional navbar
  35 links:
  36   - name: "ansible"
  37     icon: "fa-github"
  38     url: "https://github.com/xxxxx/ansible/"
  39   - name: "Wiki"
  40     icon: "fa-book"
  41     url: "https://wiki.xxxxxx.com/"
  42
  43 # Services
  44 # First level array represent a group.
  45 # Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
  46 services:
  47   - name: "DevOps"
  48     icon: "fa-code-fork"
  49     items:
  50       - name: "Jenkins"
  51         logo: "/assets/tools/jenkins.png"
  52         # Alternatively a fa icon can be provided:
  53         # icon: "fab fa-jenkins"
  54         subtitle: "Continuous integration server"
  55         tag: "CI"
  56         url: "#"
  57       - name: "RabbitMQ Management"
  58         logo: "/assets/tools/rabbitmq.png"
  59         subtitle: "Manage & monitor RabbitMQ server"
  60         tag: "haproxy"
  61         url: "#"
  62   - name: "Monitoring"
  63     icon: "fa-heartbeat"
  64     items:
  65       - name: "M/Monit"
  66         logo: "/assets/tools/monit.png"
  67         subtitle: "Monitor & manage all monit enabled hosts"
  68         tag: "monit"
  69         url: "#"
  70       - name: "Grafana"
  71         logo: "/assets/tools/grafana.png"
  72         subtitle: "Metric analytics & dashboards"
  73         url: "#"
  74       - name: "Kibana"
  75         logo: "/assets/tools/elastic.png"
  76         subtitle: "Explore & visualize logs"
  77         tag: "elk"
  78         url: "#"
  79       - name: "Website monitoring"
  80         logo: "/assets/tools/pingdom.png"
  81         subtitle: "Pingdom public reports overview"
  82         tag: "CI"
  83         url: "#"
  84
  85 ```