Release 24.04.1

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

diff --git a/README.md b/README.md
index 783e4656d0fd899b28668be4483de89ff743cac1..f97d3de074f3b2fc45c53a09e92324115c7e6fbe 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,7 +10,9 @@
 <h4 align="center">
  A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
 </h4>
-
+<p align="center"> 
+  <a href="https://www.buymeacoffee.com/bastien" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+<p>
 <p align="center">
  <strong>
    <a href="https://homer-demo.netlify.app">Demo</a>
@@ -30,6 +32,9 @@
   <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
   alt="Download homer static build"
   src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://twitter.com/acdlite/status/974390255393505280"><img
+  alt="speed-blazing"
+  src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-red"></a>
  <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
   alt="Awesome"
   src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
@@ -92,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
 
@@ -116,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
 
-# **OR** Using npm
-npm install
-npm run build
+# 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
+pnpm install
+pnpm build
 ```
 
 Then your dashboard is ready to use in the `/dist` directory.