From bcb2c84cfaa86f55a9aa3a202bd01189478a4beb Mon Sep 17 00:00:00 2001 From: Branden Cash Date: Sat, 24 Apr 2021 11:27:29 -0700 Subject: [PATCH] docs: Document HOST_WHITELIST_ENTRIES for sabnzbd (#825) Updated the list of ways around the host check in sabnzbd...we have a more convenient 3rd option in place already. Signed-off-by: Branden Cash --- charts/stable/sabnzbd/Chart.yaml | 2 +- charts/stable/sabnzbd/README.md | 7 ++----- charts/stable/sabnzbd/README_CONFIG.md.gotmpl | 5 +---- hack/gen-helm-docs.sh | 2 +- 4 files changed, 5 insertions(+), 11 deletions(-) diff --git a/charts/stable/sabnzbd/Chart.yaml b/charts/stable/sabnzbd/Chart.yaml index a7f980c9..1dcea2f9 100644 --- a/charts/stable/sabnzbd/Chart.yaml +++ b/charts/stable/sabnzbd/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v3.2.1 description: Free and easy binary newsreader name: sabnzbd -version: 7.0.0 +version: 7.0.1 kubeVersion: ">=1.16.0-0" keywords: - sabnzbd diff --git a/charts/stable/sabnzbd/README.md b/charts/stable/sabnzbd/README.md index 3132d354..1bb84460 100644 --- a/charts/stable/sabnzbd/README.md +++ b/charts/stable/sabnzbd/README.md @@ -1,6 +1,6 @@ # sabnzbd -![Version: 7.0.0](https://img.shields.io/badge/Version-7.0.0-informational?style=flat-square) ![AppVersion: v3.2.1](https://img.shields.io/badge/AppVersion-v3.2.1-informational?style=flat-square) +![Version: 7.0.1](https://img.shields.io/badge/Version-7.0.1-informational?style=flat-square) ![AppVersion: v3.2.1](https://img.shields.io/badge/AppVersion-v3.2.1-informational?style=flat-square) Free and easy binary newsreader @@ -70,10 +70,7 @@ helm install sabnzbd k8s-at-home/sabnzbd -f values.yaml **IMPORTANT NOTE:** when installing this chart for the first time you will get the follow message in your browser when trying to access Sabnzbd: `Access denied - Hostname verification failed: sabnzbd.org/hostname-check` -You can do one of two things to solve this issue: - -1. Update the `sabnzbd.ini` config file to your `ingress` name and/or `loadBalancerIP` to the `host_whitelist` field and restart the pod, or -2. Forward the service to your local machine with `kubectl port-forward service/sabnzbd -n default 8080:8080` and update the `host_whitelist` in the Sabnzbd Settings UI +To address this issue, you can set an environment variable named `HOST_WHITELIST_ENTRIES` with the host(s) you would like added to the `host_whitelist` in the `sabnzbd.ini` ## Values diff --git a/charts/stable/sabnzbd/README_CONFIG.md.gotmpl b/charts/stable/sabnzbd/README_CONFIG.md.gotmpl index 40e857fc..68dfb828 100644 --- a/charts/stable/sabnzbd/README_CONFIG.md.gotmpl +++ b/charts/stable/sabnzbd/README_CONFIG.md.gotmpl @@ -7,9 +7,6 @@ **IMPORTANT NOTE:** when installing this chart for the first time you will get the follow message in your browser when trying to access Sabnzbd: `Access denied - Hostname verification failed: sabnzbd.org/hostname-check` -You can do one of two things to solve this issue: - -1. Update the `sabnzbd.ini` config file to your `ingress` name and/or `loadBalancerIP` to the `host_whitelist` field and restart the pod, or -2. Forward the service to your local machine with `kubectl port-forward service/sabnzbd -n default 8080:8080` and update the `host_whitelist` in the Sabnzbd Settings UI +To address this issue, you can set an environment variable named `HOST_WHITELIST_ENTRIES` with the host(s) you would like added to the `host_whitelist` in the `sabnzbd.ini` {{- end -}} diff --git a/hack/gen-helm-docs.sh b/hack/gen-helm-docs.sh index 7d8c838c..ec3f0e19 100755 --- a/hack/gen-helm-docs.sh +++ b/hack/gen-helm-docs.sh @@ -6,7 +6,7 @@ set -eu # require helm-docs command -v helm-docs >/dev/null 2>&1 || { - echo >&2 "helm-docs is not installed. Aborting." + echo >&2 "helm-docs (https://github.com/norwoodj/helm-docs) is not installed. Aborting." exit 1 }