X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=d69796aa3494cc924d7b50cc3df5a7d432810357;hb=acd6a8911be0804374b5600f2125e97eb178bfa5;hp=ea93f4febf05614e5a54fb575a36535ac730eb62;hpb=d57821b5fa8b994bc4082f7565a072090ff288a1;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index ea93f4f..d69796a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@

A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

- +

+ Buy Me A Coffee +

Demo @@ -30,6 +32,9 @@ Download homer static build + speed-blazing Awesome @@ -89,6 +94,10 @@ Install example configuration file & assets (favicons, ...) to help you get star * **`SUBFOLDER`** (default: `null`) If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`). +* **`PORT`** (default: `8080`) +If you would like to change internal port of Homer from default `8080` to your port choice. + + #### With docker-compose A [`docker-compose.yml`](docker-compose.yml) file is available as an example. It must be edited to match your needs. You probably want to adjust the port mapping and volume binding (equivalent to `-p` and `-v` arguments). @@ -112,6 +121,23 @@ cp assets/config.yml.dist assets/config.yml npx serve # or python -m http.server 8010 or apache, nginx ... ``` +### Using Helm + +Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer): + +```sh +helm repo add djjudas21 https://djjudas21.github.io/charts/ +helm repo update djjudas21 + +# install with all defaults +helm install homer djjudas21/homer + +# install with customisations +wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml +# edit values.yaml +helm install homer djjudas21/homer -f values.yaml +``` + ### Build manually ```sh