X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f97d3de074f3b2fc45c53a09e92324115c7e6fbe;hb=refs%2Fheads%2Fmain;hp=6ac71e62974c0b0907dd72e1603a0016b50b68e1;hpb=049f85221e945b90bf87d21afe4d306839d65740;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 6ac71e6..f97d3de 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,9 +70,9 @@ ## 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 @@ -79,26 +84,25 @@ docker run -d \ b4bz/homer:latest ``` -Environment variables: +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. + +**Environment variables:** * **`INIT_ASSETS`** (default: `1`) -Install exemple configuration file & assets (favicons, ...) to help you get started. +Install example configuration file & assets (favicons, ...) to help you get started. * **`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. -### Using docker-compose +* **`IPV6_DISABLE`** (default: 0) +Set to `1` to disable listening on IPv6. -The `docker-compose.yml` file must be edited to match your needs. -You probably want to set the port mapping and volume binding (equivalent to `-p` and `-v` arguments): +#### With docker-compose -```yaml -volumes: - - /your/local/assets/:/www/assets -ports: - - 8080:8080 -``` +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). Then launch the container: @@ -119,16 +123,28 @@ cp assets/config.yml.dist assets/config.yml npx serve # or python -m http.server 8010 or apache, nginx ... ``` -### Build manually +### Using Helm + +Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer): ```sh -# Using yarn (recommended) -yarn install -yarn build +helm repo add djjudas21 https://djjudas21.github.io/charts/ +helm repo update djjudas21 + +# install with all defaults +helm install homer djjudas21/homer -# **OR** Using npm -npm install -npm run build +# 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 +pnpm install +pnpm build ``` Then your dashboard is ready to use in the `/dist` directory.