From 313b4c661ec08d5beb834a58182c103bc591474b Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Sun, 6 Aug 2023 01:46:17 -0500 Subject: [PATCH] :memo: Add OCI install docs --- charts/adguard-home/Chart.yaml | 2 ++ charts/adguard-home/README.md | 16 ++++++++------- charts/ascii-movie/Chart.yaml | 2 ++ charts/ascii-movie/README.md | 16 ++++++++------- charts/bookstack/Chart.yaml | 2 ++ charts/bookstack/README.md | 16 ++++++++------- charts/borgmatic/Chart.yaml | 2 ++ charts/borgmatic/README.md | 16 ++++++++------- charts/changedetection-io/Chart.yaml | 2 ++ charts/changedetection-io/README.md | 16 ++++++++------- charts/domain-watch/Chart.yaml | 2 ++ charts/domain-watch/README.md | 16 ++++++++------- charts/esphome/Chart.yaml | 2 ++ charts/esphome/README.md | 16 ++++++++------- charts/flame/Chart.yaml | 2 ++ charts/flame/README.md | 16 ++++++++------- charts/generic-device-plugin/Chart.yaml | 2 ++ charts/generic-device-plugin/README.md | 16 ++++++++------- charts/gotify/Chart.yaml | 2 ++ charts/gotify/README.md | 16 ++++++++------- charts/hammond/Chart.yaml | 2 ++ charts/hammond/README.md | 16 ++++++++------- charts/headscale/Chart.yaml | 2 ++ charts/headscale/README.md | 16 ++++++++------- charts/healthchecks/Chart.yaml | 2 ++ charts/healthchecks/README.md | 16 ++++++++------- charts/home-assistant/Chart.yaml | 2 ++ charts/home-assistant/README.md | 16 ++++++++------- charts/homer/Chart.yaml | 2 ++ charts/homer/README.md | 16 ++++++++------- charts/limo/Chart.yaml | 2 ++ charts/limo/README.md | 16 ++++++++------- charts/matrimony/Chart.yaml | 2 ++ charts/matrimony/README.md | 16 ++++++++------- charts/memos/Chart.yaml | 2 ++ charts/memos/README.md | 16 ++++++++------- charts/miniflux/Chart.yaml | 2 ++ charts/miniflux/README.md | 16 ++++++++------- charts/mnemonic-ninja/Chart.yaml | 2 ++ charts/mnemonic-ninja/README.md | 16 ++++++++------- charts/monica/Chart.yaml | 2 ++ charts/monica/README.md | 16 ++++++++------- charts/nightscout/Chart.yaml | 2 ++ charts/nightscout/README.md | 16 ++++++++------- charts/obico/Chart.yaml | 2 ++ charts/obico/README.md | 16 ++++++++------- charts/paperless-ngx/Chart.yaml | 2 ++ charts/paperless-ngx/README.md | 16 ++++++++------- charts/pictshare/Chart.yaml | 2 ++ charts/pictshare/README.md | 16 ++++++++------- charts/plex/Chart.yaml | 2 ++ charts/plex/README.md | 16 ++++++++------- charts/podgrab/Chart.yaml | 2 ++ charts/podgrab/README.md | 16 ++++++++------- charts/qbittorrent/Chart.yaml | 2 ++ charts/qbittorrent/README.md | 16 ++++++++------- charts/relax-sounds/Chart.yaml | 2 ++ charts/relax-sounds/README.md | 16 ++++++++------- charts/rss-bridge/Chart.yaml | 2 ++ charts/rss-bridge/README.md | 16 ++++++++------- charts/rsshub/Chart.yaml | 2 ++ charts/rsshub/README.md | 16 ++++++++------- charts/scanservjs/Chart.yaml | 2 ++ charts/scanservjs/README.md | 16 ++++++++------- charts/smarter-device-manager/Chart.yaml | 2 ++ charts/smarter-device-manager/README.md | 16 ++++++++------- charts/tandoor/Chart.yaml | 2 ++ charts/tandoor/README.md | 16 ++++++++------- charts/transsmute/Chart.yaml | 2 ++ charts/transsmute/README.md | 16 ++++++++------- charts/vaultwarden/Chart.yaml | 2 ++ charts/vaultwarden/README.md | 16 ++++++++------- hack/templates/README.md.gotmpl | 26 +++++++++++++----------- 73 files changed, 410 insertions(+), 264 deletions(-) diff --git a/charts/adguard-home/Chart.yaml b/charts/adguard-home/Chart.yaml index 2e746fdd1..3da5c6a8c 100644 --- a/charts/adguard-home/Chart.yaml +++ b/charts/adguard-home/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/AdguardTeam/AdGuardHome diff --git a/charts/adguard-home/README.md b/charts/adguard-home/README.md index bdd2d029b..e6a7ea414 100644 --- a/charts/adguard-home/README.md +++ b/charts/adguard-home/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `adguard-home` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install adguard-home gabe565/adguard-home +helm install adguard-home oci://ghcr.io/gabe565/charts/adguard-home ``` -## Installing the Chart - -To install the chart with the release name `adguard-home` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install adguard-home gabe565/adguard-home ``` diff --git a/charts/ascii-movie/Chart.yaml b/charts/ascii-movie/Chart.yaml index 2924e6d2d..73dc261ac 100644 --- a/charts/ascii-movie/Chart.yaml +++ b/charts/ascii-movie/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/ascii-movie diff --git a/charts/ascii-movie/README.md b/charts/ascii-movie/README.md index cfe78dcff..78fdad974 100644 --- a/charts/ascii-movie/README.md +++ b/charts/ascii-movie/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `ascii-movie` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install ascii-movie gabe565/ascii-movie +helm install ascii-movie oci://ghcr.io/gabe565/charts/ascii-movie ``` -## Installing the Chart - -To install the chart with the release name `ascii-movie` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install ascii-movie gabe565/ascii-movie ``` diff --git a/charts/bookstack/Chart.yaml b/charts/bookstack/Chart.yaml index df0d24abc..31acb3e47 100644 --- a/charts/bookstack/Chart.yaml +++ b/charts/bookstack/Chart.yaml @@ -29,6 +29,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update mariadb Helm release to v11.5.7 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/BookStackApp/BookStack diff --git a/charts/bookstack/README.md b/charts/bookstack/README.md index ccc7b38a8..2f5171587 100644 --- a/charts/bookstack/README.md +++ b/charts/bookstack/README.md @@ -29,19 +29,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | mariadb | 11.5.7 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `bookstack` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install bookstack gabe565/bookstack +helm install bookstack oci://ghcr.io/gabe565/charts/bookstack ``` -## Installing the Chart - -To install the chart with the release name `bookstack` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install bookstack gabe565/bookstack ``` diff --git a/charts/borgmatic/Chart.yaml b/charts/borgmatic/Chart.yaml index a7cd4ca1e..99042c0b0 100644 --- a/charts/borgmatic/Chart.yaml +++ b/charts/borgmatic/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://projects.torsion.org/borgmatic-collective/borgmatic diff --git a/charts/borgmatic/README.md b/charts/borgmatic/README.md index c43ac29c9..0465dfb1b 100644 --- a/charts/borgmatic/README.md +++ b/charts/borgmatic/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.21.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `borgmatic` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install borgmatic gabe565/borgmatic +helm install borgmatic oci://ghcr.io/gabe565/charts/borgmatic ``` -## Installing the Chart - -To install the chart with the release name `borgmatic` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install borgmatic gabe565/borgmatic ``` diff --git a/charts/changedetection-io/Chart.yaml b/charts/changedetection-io/Chart.yaml index e2836f8b2..f524115ad 100644 --- a/charts/changedetection-io/Chart.yaml +++ b/charts/changedetection-io/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/dgtlmoon/changedetection.io diff --git a/charts/changedetection-io/README.md b/charts/changedetection-io/README.md index f349e3274..6818191d9 100644 --- a/charts/changedetection-io/README.md +++ b/charts/changedetection-io/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `changedetection-io` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install changedetection-io gabe565/changedetection-io +helm install changedetection-io oci://ghcr.io/gabe565/charts/changedetection-io ``` -## Installing the Chart - -To install the chart with the release name `changedetection-io` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install changedetection-io gabe565/changedetection-io ``` diff --git a/charts/domain-watch/Chart.yaml b/charts/domain-watch/Chart.yaml index 18680e7c2..85bf6793f 100644 --- a/charts/domain-watch/Chart.yaml +++ b/charts/domain-watch/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/domain-watch diff --git a/charts/domain-watch/README.md b/charts/domain-watch/README.md index c0cf8ed44..ebb813b60 100644 --- a/charts/domain-watch/README.md +++ b/charts/domain-watch/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `domain-watch` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install domain-watch gabe565/domain-watch +helm install domain-watch oci://ghcr.io/gabe565/charts/domain-watch ``` -## Installing the Chart - -To install the chart with the release name `domain-watch` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install domain-watch gabe565/domain-watch ``` diff --git a/charts/esphome/Chart.yaml b/charts/esphome/Chart.yaml index cdac46c57..1a0f55117 100644 --- a/charts/esphome/Chart.yaml +++ b/charts/esphome/Chart.yaml @@ -24,6 +24,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/esphome/esphome diff --git a/charts/esphome/README.md b/charts/esphome/README.md index 58cdbb609..e4ead10e8 100644 --- a/charts/esphome/README.md +++ b/charts/esphome/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `esphome` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install esphome gabe565/esphome +helm install esphome oci://ghcr.io/gabe565/charts/esphome ``` -## Installing the Chart - -To install the chart with the release name `esphome` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install esphome gabe565/esphome ``` diff --git a/charts/flame/Chart.yaml b/charts/flame/Chart.yaml index 460b36533..59c0857a2 100644 --- a/charts/flame/Chart.yaml +++ b/charts/flame/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/pawelmalak/flame diff --git a/charts/flame/README.md b/charts/flame/README.md index c75e1778c..59816530f 100644 --- a/charts/flame/README.md +++ b/charts/flame/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `flame` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install flame gabe565/flame +helm install flame oci://ghcr.io/gabe565/charts/flame ``` -## Installing the Chart - -To install the chart with the release name `flame` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install flame gabe565/flame ``` diff --git a/charts/generic-device-plugin/Chart.yaml b/charts/generic-device-plugin/Chart.yaml index 4e5e340ca..fa7e29e97 100644 --- a/charts/generic-device-plugin/Chart.yaml +++ b/charts/generic-device-plugin/Chart.yaml @@ -19,6 +19,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/squat/generic-device-plugin diff --git a/charts/generic-device-plugin/README.md b/charts/generic-device-plugin/README.md index a9b49ac3a..143e99c2f 100644 --- a/charts/generic-device-plugin/README.md +++ b/charts/generic-device-plugin/README.md @@ -25,19 +25,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `generic-device-plugin` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install generic-device-plugin gabe565/generic-device-plugin +helm install generic-device-plugin oci://ghcr.io/gabe565/charts/generic-device-plugin ``` -## Installing the Chart - -To install the chart with the release name `generic-device-plugin` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install generic-device-plugin gabe565/generic-device-plugin ``` diff --git a/charts/gotify/Chart.yaml b/charts/gotify/Chart.yaml index 34f4b8218..223c5cd80 100644 --- a/charts/gotify/Chart.yaml +++ b/charts/gotify/Chart.yaml @@ -24,6 +24,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gotify/server diff --git a/charts/gotify/README.md b/charts/gotify/README.md index de97d6157..9da44a9b6 100644 --- a/charts/gotify/README.md +++ b/charts/gotify/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `gotify` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install gotify gabe565/gotify +helm install gotify oci://ghcr.io/gabe565/charts/gotify ``` -## Installing the Chart - -To install the chart with the release name `gotify` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install gotify gabe565/gotify ``` diff --git a/charts/hammond/Chart.yaml b/charts/hammond/Chart.yaml index fa241fb1d..0c2a42bcd 100644 --- a/charts/hammond/Chart.yaml +++ b/charts/hammond/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/akhilrex/hammond diff --git a/charts/hammond/README.md b/charts/hammond/README.md index 65902f7fc..5adc44389 100644 --- a/charts/hammond/README.md +++ b/charts/hammond/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `hammond` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install hammond gabe565/hammond +helm install hammond oci://ghcr.io/gabe565/charts/hammond ``` -## Installing the Chart - -To install the chart with the release name `hammond` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install hammond gabe565/hammond ``` diff --git a/charts/headscale/Chart.yaml b/charts/headscale/Chart.yaml index 9605355e0..579a8566c 100644 --- a/charts/headscale/Chart.yaml +++ b/charts/headscale/Chart.yaml @@ -29,6 +29,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/juanfont/headscale diff --git a/charts/headscale/README.md b/charts/headscale/README.md index 7ba7f8308..e708c7011 100644 --- a/charts/headscale/README.md +++ b/charts/headscale/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `headscale` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install headscale gabe565/headscale +helm install headscale oci://ghcr.io/gabe565/charts/headscale ``` -## Installing the Chart - -To install the chart with the release name `headscale` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install headscale gabe565/headscale ``` diff --git a/charts/healthchecks/Chart.yaml b/charts/healthchecks/Chart.yaml index 871000c33..543348a51 100644 --- a/charts/healthchecks/Chart.yaml +++ b/charts/healthchecks/Chart.yaml @@ -34,6 +34,8 @@ annotations: description: Update mariadb Helm release to v11.5.7 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/healthchecks/healthchecks diff --git a/charts/healthchecks/README.md b/charts/healthchecks/README.md index 883dab123..4e7385507 100644 --- a/charts/healthchecks/README.md +++ b/charts/healthchecks/README.md @@ -29,19 +29,21 @@ Kubernetes: `>=1.22.0-0` | | mariadb | 11.5.7 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `healthchecks` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install healthchecks gabe565/healthchecks +helm install healthchecks oci://ghcr.io/gabe565/charts/healthchecks ``` -## Installing the Chart - -To install the chart with the release name `healthchecks` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install healthchecks gabe565/healthchecks ``` diff --git a/charts/home-assistant/Chart.yaml b/charts/home-assistant/Chart.yaml index eedee2aae..8c3dca737 100644 --- a/charts/home-assistant/Chart.yaml +++ b/charts/home-assistant/Chart.yaml @@ -29,6 +29,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/home-assistant/core diff --git a/charts/home-assistant/README.md b/charts/home-assistant/README.md index 5a577ed6d..031105955 100644 --- a/charts/home-assistant/README.md +++ b/charts/home-assistant/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `home-assistant` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install home-assistant gabe565/home-assistant +helm install home-assistant oci://ghcr.io/gabe565/charts/home-assistant ``` -## Installing the Chart - -To install the chart with the release name `home-assistant` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install home-assistant gabe565/home-assistant ``` diff --git a/charts/homer/Chart.yaml b/charts/homer/Chart.yaml index 16055daf2..0368bc814 100644 --- a/charts/homer/Chart.yaml +++ b/charts/homer/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/bastienwirtz/homer diff --git a/charts/homer/README.md b/charts/homer/README.md index f3b4a94bd..c4af9bf2b 100644 --- a/charts/homer/README.md +++ b/charts/homer/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `homer` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install homer gabe565/homer +helm install homer oci://ghcr.io/gabe565/charts/homer ``` -## Installing the Chart - -To install the chart with the release name `homer` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install homer gabe565/homer ``` diff --git a/charts/limo/Chart.yaml b/charts/limo/Chart.yaml index b3e70ea91..6305663cd 100644 --- a/charts/limo/Chart.yaml +++ b/charts/limo/Chart.yaml @@ -23,6 +23,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/limo diff --git a/charts/limo/README.md b/charts/limo/README.md index 89307e7f1..0db9da458 100644 --- a/charts/limo/README.md +++ b/charts/limo/README.md @@ -26,19 +26,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `limo` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install limo gabe565/limo +helm install limo oci://ghcr.io/gabe565/charts/limo ``` -## Installing the Chart - -To install the chart with the release name `limo` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install limo gabe565/limo ``` diff --git a/charts/matrimony/Chart.yaml b/charts/matrimony/Chart.yaml index 91bba3491..02222c524 100644 --- a/charts/matrimony/Chart.yaml +++ b/charts/matrimony/Chart.yaml @@ -18,6 +18,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/matrimony diff --git a/charts/matrimony/README.md b/charts/matrimony/README.md index c004dc2c9..9e4f72069 100644 --- a/charts/matrimony/README.md +++ b/charts/matrimony/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `matrimony` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install matrimony gabe565/matrimony +helm install matrimony oci://ghcr.io/gabe565/charts/matrimony ``` -## Installing the Chart - -To install the chart with the release name `matrimony` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install matrimony gabe565/matrimony ``` diff --git a/charts/memos/Chart.yaml b/charts/memos/Chart.yaml index 4028e333e..493acb58f 100644 --- a/charts/memos/Chart.yaml +++ b/charts/memos/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/usememos/memos diff --git a/charts/memos/README.md b/charts/memos/README.md index 59de02e3e..b1d5e69ce 100644 --- a/charts/memos/README.md +++ b/charts/memos/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `memos` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install memos gabe565/memos +helm install memos oci://ghcr.io/gabe565/charts/memos ``` -## Installing the Chart - -To install the chart with the release name `memos` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install memos gabe565/memos ``` diff --git a/charts/miniflux/Chart.yaml b/charts/miniflux/Chart.yaml index 1c65e84bf..f820c5844 100644 --- a/charts/miniflux/Chart.yaml +++ b/charts/miniflux/Chart.yaml @@ -29,6 +29,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/miniflux/v2 diff --git a/charts/miniflux/README.md b/charts/miniflux/README.md index 12a1021a7..7a7859e28 100644 --- a/charts/miniflux/README.md +++ b/charts/miniflux/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `miniflux` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install miniflux gabe565/miniflux +helm install miniflux oci://ghcr.io/gabe565/charts/miniflux ``` -## Installing the Chart - -To install the chart with the release name `miniflux` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install miniflux gabe565/miniflux ``` diff --git a/charts/mnemonic-ninja/Chart.yaml b/charts/mnemonic-ninja/Chart.yaml index 2800f4ecb..4e560ba57 100644 --- a/charts/mnemonic-ninja/Chart.yaml +++ b/charts/mnemonic-ninja/Chart.yaml @@ -18,6 +18,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/mnemonic-ninja diff --git a/charts/mnemonic-ninja/README.md b/charts/mnemonic-ninja/README.md index 8d576dfb6..018884c09 100644 --- a/charts/mnemonic-ninja/README.md +++ b/charts/mnemonic-ninja/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `mnemonic-ninja` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install mnemonic-ninja gabe565/mnemonic-ninja +helm install mnemonic-ninja oci://ghcr.io/gabe565/charts/mnemonic-ninja ``` -## Installing the Chart - -To install the chart with the release name `mnemonic-ninja` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install mnemonic-ninja gabe565/mnemonic-ninja ``` diff --git a/charts/monica/Chart.yaml b/charts/monica/Chart.yaml index 26bb8bd3f..23f9aab74 100644 --- a/charts/monica/Chart.yaml +++ b/charts/monica/Chart.yaml @@ -26,6 +26,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update mariadb Helm release to v11.5.7 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/monicahq/monica diff --git a/charts/monica/README.md b/charts/monica/README.md index 143c6f389..3978d7df3 100644 --- a/charts/monica/README.md +++ b/charts/monica/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | mariadb | 11.5.7 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `monica` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install monica gabe565/monica +helm install monica oci://ghcr.io/gabe565/charts/monica ``` -## Installing the Chart - -To install the chart with the release name `monica` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install monica gabe565/monica ``` diff --git a/charts/nightscout/Chart.yaml b/charts/nightscout/Chart.yaml index 227c2567e..51700f478 100644 --- a/charts/nightscout/Chart.yaml +++ b/charts/nightscout/Chart.yaml @@ -28,6 +28,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update mongodb Helm release to v13.16.2 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/nightscout/cgm-remote-monitor diff --git a/charts/nightscout/README.md b/charts/nightscout/README.md index 831409e2a..d728198f6 100644 --- a/charts/nightscout/README.md +++ b/charts/nightscout/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | mongodb | 13.16.2 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `nightscout` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install nightscout gabe565/nightscout +helm install nightscout oci://ghcr.io/gabe565/charts/nightscout ``` -## Installing the Chart - -To install the chart with the release name `nightscout` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install nightscout gabe565/nightscout ``` diff --git a/charts/obico/Chart.yaml b/charts/obico/Chart.yaml index 714db61ca..2c58d5ac8 100644 --- a/charts/obico/Chart.yaml +++ b/charts/obico/Chart.yaml @@ -27,6 +27,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update redis Helm release to v17.14.5 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/TheSpaghettiDetective/obico-server diff --git a/charts/obico/README.md b/charts/obico/README.md index 96a1d32b4..0d8b075e5 100644 --- a/charts/obico/README.md +++ b/charts/obico/README.md @@ -29,19 +29,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | redis | 17.14.5 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `obico` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install obico gabe565/obico +helm install obico oci://ghcr.io/gabe565/charts/obico ``` -## Installing the Chart - -To install the chart with the release name `obico` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install obico gabe565/obico ``` diff --git a/charts/paperless-ngx/Chart.yaml b/charts/paperless-ngx/Chart.yaml index 51544e46d..26baad378 100644 --- a/charts/paperless-ngx/Chart.yaml +++ b/charts/paperless-ngx/Chart.yaml @@ -41,6 +41,8 @@ annotations: description: Update postgresql Helm release to v12.8.0 - kind: changed description: Update redis Helm release to v17.14.5 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/paperless-ngx/paperless-ngx diff --git a/charts/paperless-ngx/README.md b/charts/paperless-ngx/README.md index 5811ed465..ca41871d9 100644 --- a/charts/paperless-ngx/README.md +++ b/charts/paperless-ngx/README.md @@ -30,19 +30,21 @@ Kubernetes: `>=1.22.0-0` | | postgresql | 12.8.0 | | | redis | 17.14.5 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `paperless-ngx` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install paperless-ngx gabe565/paperless-ngx +helm install paperless-ngx oci://ghcr.io/gabe565/charts/paperless-ngx ``` -## Installing the Chart - -To install the chart with the release name `paperless-ngx` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install paperless-ngx gabe565/paperless-ngx ``` diff --git a/charts/pictshare/Chart.yaml b/charts/pictshare/Chart.yaml index 6fff191df..3f416df18 100644 --- a/charts/pictshare/Chart.yaml +++ b/charts/pictshare/Chart.yaml @@ -23,6 +23,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/HaschekSolutions/pictshare diff --git a/charts/pictshare/README.md b/charts/pictshare/README.md index 37c212161..31fd32365 100644 --- a/charts/pictshare/README.md +++ b/charts/pictshare/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `pictshare` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install pictshare gabe565/pictshare +helm install pictshare oci://ghcr.io/gabe565/charts/pictshare ``` -## Installing the Chart - -To install the chart with the release name `pictshare` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install pictshare gabe565/pictshare ``` diff --git a/charts/plex/Chart.yaml b/charts/plex/Chart.yaml index 85462ad12..fd9a04773 100644 --- a/charts/plex/Chart.yaml +++ b/charts/plex/Chart.yaml @@ -20,6 +20,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App homepage url: https://plex.tv diff --git a/charts/plex/README.md b/charts/plex/README.md index 208b1e888..4c2fd7540 100644 --- a/charts/plex/README.md +++ b/charts/plex/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `plex` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install plex gabe565/plex +helm install plex oci://ghcr.io/gabe565/charts/plex ``` -## Installing the Chart - -To install the chart with the release name `plex` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install plex gabe565/plex ``` diff --git a/charts/podgrab/Chart.yaml b/charts/podgrab/Chart.yaml index 4b7daea4a..d5691573e 100644 --- a/charts/podgrab/Chart.yaml +++ b/charts/podgrab/Chart.yaml @@ -20,6 +20,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/akhilrex/podgrab diff --git a/charts/podgrab/README.md b/charts/podgrab/README.md index b98b9b9c0..d2b4f0266 100644 --- a/charts/podgrab/README.md +++ b/charts/podgrab/README.md @@ -25,19 +25,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `podgrab` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install podgrab gabe565/podgrab +helm install podgrab oci://ghcr.io/gabe565/charts/podgrab ``` -## Installing the Chart - -To install the chart with the release name `podgrab` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install podgrab gabe565/podgrab ``` diff --git a/charts/qbittorrent/Chart.yaml b/charts/qbittorrent/Chart.yaml index 9cd73f7e0..0218f0049 100644 --- a/charts/qbittorrent/Chart.yaml +++ b/charts/qbittorrent/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/qbittorrent/qBittorrent diff --git a/charts/qbittorrent/README.md b/charts/qbittorrent/README.md index 8bb98c06d..32cd5be0f 100644 --- a/charts/qbittorrent/README.md +++ b/charts/qbittorrent/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `qbittorrent` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install qbittorrent gabe565/qbittorrent +helm install qbittorrent oci://ghcr.io/gabe565/charts/qbittorrent ``` -## Installing the Chart - -To install the chart with the release name `qbittorrent` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install qbittorrent gabe565/qbittorrent ``` diff --git a/charts/relax-sounds/Chart.yaml b/charts/relax-sounds/Chart.yaml index 0361170ba..00d75a211 100644 --- a/charts/relax-sounds/Chart.yaml +++ b/charts/relax-sounds/Chart.yaml @@ -18,6 +18,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/relax-sounds diff --git a/charts/relax-sounds/README.md b/charts/relax-sounds/README.md index 14d95192b..24dfdb734 100644 --- a/charts/relax-sounds/README.md +++ b/charts/relax-sounds/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `relax-sounds` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install relax-sounds gabe565/relax-sounds +helm install relax-sounds oci://ghcr.io/gabe565/charts/relax-sounds ``` -## Installing the Chart - -To install the chart with the release name `relax-sounds` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install relax-sounds gabe565/relax-sounds ``` diff --git a/charts/rss-bridge/Chart.yaml b/charts/rss-bridge/Chart.yaml index 16d61e1e2..f326d2a62 100644 --- a/charts/rss-bridge/Chart.yaml +++ b/charts/rss-bridge/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/RSS-Bridge/rss-bridge diff --git a/charts/rss-bridge/README.md b/charts/rss-bridge/README.md index 7a2245d5a..bce692940 100644 --- a/charts/rss-bridge/README.md +++ b/charts/rss-bridge/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `rss-bridge` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install rss-bridge gabe565/rss-bridge +helm install rss-bridge oci://ghcr.io/gabe565/charts/rss-bridge ``` -## Installing the Chart - -To install the chart with the release name `rss-bridge` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install rss-bridge gabe565/rss-bridge ``` diff --git a/charts/rsshub/Chart.yaml b/charts/rsshub/Chart.yaml index 7d67ef36d..039e29845 100644 --- a/charts/rsshub/Chart.yaml +++ b/charts/rsshub/Chart.yaml @@ -28,6 +28,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update redis Helm release to v17.14.5 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/DIYgod/RSSHub diff --git a/charts/rsshub/README.md b/charts/rsshub/README.md index a7065cc3e..129237fb0 100644 --- a/charts/rsshub/README.md +++ b/charts/rsshub/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | redis | 17.14.5 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `rsshub` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install rsshub gabe565/rsshub +helm install rsshub oci://ghcr.io/gabe565/charts/rsshub ``` -## Installing the Chart - -To install the chart with the release name `rsshub` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install rsshub gabe565/rsshub ``` diff --git a/charts/scanservjs/Chart.yaml b/charts/scanservjs/Chart.yaml index 4bb8e32a7..5f83f533b 100644 --- a/charts/scanservjs/Chart.yaml +++ b/charts/scanservjs/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/sbs20/scanservjs diff --git a/charts/scanservjs/README.md b/charts/scanservjs/README.md index 5f647dcfa..7ba8df15a 100644 --- a/charts/scanservjs/README.md +++ b/charts/scanservjs/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `scanservjs` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install scanservjs gabe565/scanservjs +helm install scanservjs oci://ghcr.io/gabe565/charts/scanservjs ``` -## Installing the Chart - -To install the chart with the release name `scanservjs` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install scanservjs gabe565/scanservjs ``` diff --git a/charts/smarter-device-manager/Chart.yaml b/charts/smarter-device-manager/Chart.yaml index 0526a5cbb..5af6138f9 100644 --- a/charts/smarter-device-manager/Chart.yaml +++ b/charts/smarter-device-manager/Chart.yaml @@ -24,6 +24,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://gitlab.com/arm-research/smarter/smarter-device-manager diff --git a/charts/smarter-device-manager/README.md b/charts/smarter-device-manager/README.md index 485218693..a710d3579 100644 --- a/charts/smarter-device-manager/README.md +++ b/charts/smarter-device-manager/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `smarter-device-manager` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install smarter-device-manager gabe565/smarter-device-manager +helm install smarter-device-manager oci://ghcr.io/gabe565/charts/smarter-device-manager ``` -## Installing the Chart - -To install the chart with the release name `smarter-device-manager` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install smarter-device-manager gabe565/smarter-device-manager ``` diff --git a/charts/tandoor/Chart.yaml b/charts/tandoor/Chart.yaml index 8d83b310f..30996ae50 100644 --- a/charts/tandoor/Chart.yaml +++ b/charts/tandoor/Chart.yaml @@ -30,6 +30,8 @@ annotations: description: Update common Helm release to v1.5.1 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/TandoorRecipes/recipes diff --git a/charts/tandoor/README.md b/charts/tandoor/README.md index 08f9714b0..4f6174a4a 100644 --- a/charts/tandoor/README.md +++ b/charts/tandoor/README.md @@ -28,19 +28,21 @@ Kubernetes: `>=1.22.0-0` | | common | 1.5.1 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `tandoor` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install tandoor gabe565/tandoor +helm install tandoor oci://ghcr.io/gabe565/charts/tandoor ``` -## Installing the Chart - -To install the chart with the release name `tandoor` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install tandoor gabe565/tandoor ``` diff --git a/charts/transsmute/Chart.yaml b/charts/transsmute/Chart.yaml index dc665f631..30ca4b7ab 100644 --- a/charts/transsmute/Chart.yaml +++ b/charts/transsmute/Chart.yaml @@ -22,6 +22,8 @@ annotations: artifacthub.io/changes: |- - kind: changed description: Update common Helm release to v1.5.1 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/gabe565/transsmute diff --git a/charts/transsmute/README.md b/charts/transsmute/README.md index 07e617a25..f1f1d9a3a 100644 --- a/charts/transsmute/README.md +++ b/charts/transsmute/README.md @@ -27,19 +27,21 @@ Kubernetes: `>=1.22.0-0` |------------|------|---------| | | common | 1.5.1 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `transsmute` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install transsmute gabe565/transsmute +helm install transsmute oci://ghcr.io/gabe565/charts/transsmute ``` -## Installing the Chart - -To install the chart with the release name `transsmute` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install transsmute gabe565/transsmute ``` diff --git a/charts/vaultwarden/Chart.yaml b/charts/vaultwarden/Chart.yaml index ed8a1d3af..c6ea02913 100644 --- a/charts/vaultwarden/Chart.yaml +++ b/charts/vaultwarden/Chart.yaml @@ -34,6 +34,8 @@ annotations: description: Update mariadb Helm release to v11.5.7 - kind: changed description: Update postgresql Helm release to v12.8.0 + - kind: added + description: Add OCI install docs artifacthub.io/links: |- - name: App Source url: https://github.com/dani-garcia/vaultwarden diff --git a/charts/vaultwarden/README.md b/charts/vaultwarden/README.md index 572bb58b7..71ae8ea2c 100644 --- a/charts/vaultwarden/README.md +++ b/charts/vaultwarden/README.md @@ -29,19 +29,21 @@ Kubernetes: `>=1.22.0-0` | | mariadb | 11.5.7 | | | postgresql | 12.8.0 | -## TL;DR +## Installing the Chart + +To install the chart with the release name `vaultwarden` + +### OCI (Recommended) ```console -helm repo add gabe565 https://charts.gabe565.com -helm repo update -helm install vaultwarden gabe565/vaultwarden +helm install vaultwarden oci://ghcr.io/gabe565/charts/vaultwarden ``` -## Installing the Chart - -To install the chart with the release name `vaultwarden` +### Traditional ```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update helm install vaultwarden gabe565/vaultwarden ``` diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl index 4b9279b3f..8ca30f167 100644 --- a/hack/templates/README.md.gotmpl +++ b/hack/templates/README.md.gotmpl @@ -14,6 +14,10 @@ https://charts.gabe565.com {{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} {{- end -}} +{{- define "custom.helm.oci_url" -}} +oci://ghcr.io/gabe565/charts +{{- end -}} + {{- define "custom.notes" -}} **This chart is not maintained by the upstream project and any issues with the chart should be raised [here]({{ template "custom.repository.url" . }}/issues/new?assignees=gabe565&labels=bug&template=bug_report.yaml&name={{ template "chart.name" . }}&version={{ template "chart.version" . }})** @@ -39,22 +43,22 @@ https://charts.gabe565.com {{- end }} {{- end -}} -{{- define "custom.install.tldr" -}} -## TL;DR - -```console -helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} -helm repo update -helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -``` -{{- end -}} - {{- define "custom.install" -}} ## Installing the Chart To install the chart with the release name `{{ template "chart.name" . }}` +### OCI (Recommended) + ```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.oci_url" . }}/{{ template "chart.name" . }} +``` + +### Traditional + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} ``` {{- end -}} @@ -131,8 +135,6 @@ Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/ {{ template "custom.dependencies" . }} -{{ template "custom.install.tldr" . }} - {{ template "custom.install" . }} {{ template "custom.uninstall" . }}