X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=d69796aa3494cc924d7b50cc3df5a7d432810357;hb=e3b68ddc427a62fb77acd709b2dbdc8681c49158;hp=5ea80fb84575b865f964fe2fa69be5fe58c8fd98;hpb=d92444ec19f15351f62d6008dc6d4bee6838aa2a;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 5ea80fb..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 @@ -65,14 +70,12 @@ ## Getting started -Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**. +Homer is a full static html/js dashboard, based on a simple yaml configuration file. See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. -See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. +It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**. ### Using docker -To launch container: - ```sh docker run -d \ -p 8080:8080 \ @@ -81,33 +84,29 @@ docker run -d \ b4bz/homer:latest ``` -Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`). +The container will run using a user uid and gid 1000. Add `--user :` to the docker command to adjust it. Make sure this match the ownership of your assets directory. -### Using docker-compose +**Environment variables:** -The `docker-compose.yml` file must be edited to match your needs. -Set the port and volume (equivalent to `-p` and `-v` arguments): +* **`INIT_ASSETS`** (default: `1`) +Install example configuration file & assets (favicons, ...) to help you get started. -```yaml -volumes: - - /your/local/assets/:/www/assets -ports: - - 8080:8080 -``` +* **`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`). -To launch container: +* **`PORT`** (default: `8080`) +If you would like to change internal port of Homer from default `8080` to your port choice. -```sh -cd /path/to/docker-compose.yml -docker-compose up -d -``` -Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`: +#### 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). -```yaml -environment: - - UID=1000 - - GID=1000 +Then launch the container: + +```sh +cd /path/to/docker-compose.yml/ +docker-compose up -d ``` ### Using the release tarball (prebuilt, ready to use) @@ -122,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