Release 24.04.1

[github/bastienwirtz/homer.git] / README.md

diff --git a/README.md b/README.md
index 95faada1b13722bbab244c97de7c2578f1dc0830..f97d3de074f3b2fc45c53a09e92324115c7e6fbe 100644 (file)
--- a/README.md
+++ b/README.md
@@ -97,6 +97,8 @@ If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer**
 * **`PORT`** (default: `8080`)
 If you would like to change internal port of Homer from default `8080` to your port choice.
 
+* **`IPV6_DISABLE`** (default: 0)
+Set to `1` to disable listening on IPv6.
 
 #### With docker-compose
 
@@ -121,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
+
+# 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
 
-# **OR** Using npm
-npm install
-npm run build
+```sh
+pnpm install
+pnpm build
 ```
 
 Then your dashboard is ready to use in the `/dist` directory.