X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=edd7d7071454694b159fc3a9e425896fd88e80d2;hb=46fd4f4da18ed505264181cfa8f6a776abef9e2f;hp=62bbd779a19f85cd217ae3e25c645eebbb2ab7e5;hpb=05bdc2680193564dbb8acbd85aa8d79eeec546f5;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 62bbd77..edd7d70 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,23 @@ # Homer A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. +**Check out the live demo [here](https://homer-demo.netlify.com/).** + 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, ...) ![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) -**How to build / install it? Where is the webpack config?** -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`. +## installation + +### Using docker + +```sh +sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest +``` + +### Manually + +**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`. ## configuration @@ -23,10 +34,12 @@ title: "Simple homepage" subtitle: "Homer" logo: "assets/homer.png" # Alternatively a fa icon can be provided: -# icon: "fas fa-skull-crossbones" +# icon: "fas fa-skull-crossbones" +footer: '
Created with â¤ï¸ with bulma, vuejs & font awesome // Fork me on
' # set false if you want to hide it.header: # Optional message message: + # url: "https://