From 74e77e5e539d65c06dbc3642aab0fa7a0c529361 Mon Sep 17 00:00:00 2001 From: Xstar97TheNoob <9399967+xstar97@users.noreply.github.com> Date: Mon, 2 Oct 2023 12:14:24 -0400 Subject: [PATCH] fix(sonarr) fix auth method and add docs (#13142) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** - Update the auth method list and add the None for v3. - Left External as is and rename the description for both values for the respective versions. - Added docs to better explain the auth options and give a warning on using Basic. ⚒️ Fixes #11314 **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [X] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [X] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/stable/sonarr/Chart.yaml | 2 +- .../stable/sonarr/docs/installation_notes.md | 18 ++++++++++++++++++ charts/stable/sonarr/questions.yaml | 4 ++-- 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 charts/stable/sonarr/docs/installation_notes.md diff --git a/charts/stable/sonarr/Chart.yaml b/charts/stable/sonarr/Chart.yaml index 5394c742806..4a5077839ca 100644 --- a/charts/stable/sonarr/Chart.yaml +++ b/charts/stable/sonarr/Chart.yaml @@ -22,7 +22,7 @@ sources: - https://github.com/truecharts/charts/tree/master/charts/stable/sonarr - https://github.com/Sonarr/Sonarr type: application -version: 16.0.0 +version: 16.0.1 annotations: truecharts.org/catagories: | - media diff --git a/charts/stable/sonarr/docs/installation_notes.md b/charts/stable/sonarr/docs/installation_notes.md new file mode 100644 index 00000000000..a2e88e08870 --- /dev/null +++ b/charts/stable/sonarr/docs/installation_notes.md @@ -0,0 +1,18 @@ +# Installation Notes + +## Sonarr (v3) + +The current stable version of Sonarr is v3. When configuring Sonarr v3, the default authentication method is `In-App Setting`. The available authentication methods for Sonarr v3 are as follows: + +- **In-App Setting**: Allows users to make changes via the web GUI (Graphical User Interface). +- **None**: No authentication required. +- **Basic**: Basic username and password authentication. +- **Forms**: Form-based authentication. + +For Sonarr v3, we strongly recommend using either "In-App Setting" or "None" for the authentication method. + +:::warning + +We strongly discourage the use of the "Basic" authentication method, as it may potentially impact system probes and security. + +::: diff --git a/charts/stable/sonarr/questions.yaml b/charts/stable/sonarr/questions.yaml index d7855852f25..aa2068773b2 100644 --- a/charts/stable/sonarr/questions.yaml +++ b/charts/stable/sonarr/questions.yaml @@ -27,8 +27,8 @@ questions: enum: - value: "" description: In-App Setting - - value: External - description: External/None + - value: None + description: None - value: Basic description: Basic - value: Forms