X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=11d4714d80c3ab36b038ca97268cf413024f1e27;hb=6eba37a370cdd3c0275d49fa693ab189d8ab8ff2;hp=709423f8aaf7ef5362144d0c948873bdaf1b9973;hpb=e3212743b9b59e32e7bc68c387399f41f30baef6;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 709423f..11d4714 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ # Homer -A very simple static HOMepage for your servER. -Add all your useful service, external links, notes... or anything. +A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. -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, ...) +**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 @@ -18,43 +28,54 @@ Title, icons, links, colors, and services can be configured in the `config.yml` ```yaml --- # Homepage configuration -# See https://fontawesome.com/v4.7.0/icons/ for icons options +# See https://fontawesome.com/icons for icons options title: "Simple homepage" subtitle: "Homer" logo: "assets/homer.png" +# Alternatively a fa icon can be provided: +# 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://