README.md

   1 # Homer
   2 A very simple static HOMepage for your servER.
   3 Add all your useful service, external links, notes... or anything.
   4
   5 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 tunneling, ...)
   6
   7 ![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
   8
   9 **How to build / install it? Where is the webpack config?**
  10 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`.
  11
  12
  13 ## configuration
  14
  15 Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
  16
  17
  18 ```yaml
  19 ---
  20 # Homepage configuration
  21 # See https://fontawesome.com/icons for icons options
  22
  23 title: "Simple homepage"
  24 subtitle: "Homer"
  25 logo: "assets/homer.png"
  26 # Alternatively a fa icon can be provided:
  27 # icon: "fas fa-skull-crossbones"
  28
  29 # Optional message
  30 message:
  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   - name: "Wiki"
  41     icon: "fa-book"
  42     url: "https://wiki.xxxxxx.com/"
  43
  44 # Services
  45 # First level array represent a group.
  46 # Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
  47 services:
  48   - name: "DevOps"
  49     icon: "fa-code-fork"
  50     items:
  51       - name: "Jenkins"
  52         logo: "/assets/tools/jenkins.png"
  53         # Alternatively a fa icon can be provided:
  54         # icon: "fab fa-jenkins"
  55         subtitle: "Continuous integration server"
  56         tag: "CI"
  57         url: "#"
  58       - name: "RabbitMQ Management"
  59         logo: "/assets/tools/rabbitmq.png"
  60         subtitle: "Manage & monitor RabbitMQ server"
  61         tag: "haproxy"
  62         url: "#"
  63   - name: "Monitoring"
  64     icon: "fa-heartbeat"
  65     items:
  66       - name: "M/Monit"
  67         logo: "/assets/tools/monit.png"
  68         subtitle: "Monitor & manage all monit enabled hosts"
  69         tag: "monit"
  70         url: "#"
  71       - name: "Grafana"
  72         logo: "/assets/tools/grafana.png"
  73         subtitle: "Metric analytics & dashboards"
  74         url: "#"
  75       - name: "Kibana"
  76         logo: "/assets/tools/elastic.png"
  77         subtitle: "Explore & visualize logs"
  78         tag: "elk"
  79         url: "#"
  80       - name: "Website monitoring"
  81         logo: "/assets/tools/pingdom.png"
  82         subtitle: "Pingdom public reports overview"
  83         tag: "CI"
  84         url: "#"
  85
  86 ```