From 6d4ce9af85eea37d2205879d3248cc90c5c874b5 Mon Sep 17 00:00:00 2001 From: Tanguille <91473554+Tanguille@users.noreply.github.com> Date: Sun, 5 Nov 2023 21:15:53 +0100 Subject: [PATCH] Docs(qBitrr): update installation-notes.md (#14091) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Added some explanation since I failed to configure qBitrr properly following this installation-notes. I assume something changed upstream which added a `.config` directory inside the `config` directory which now both have `config.toml` but only the one in `.config` actually applying. However if @kqmaverick installs the chart he doesn't seem to get the `.config` directory while I did on 2 instances I tested. I guess some more testing is required on why this is happening. ⚒️ Fixes outdated installation-notes **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 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 - [ ] ⬆️ 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` --- --------- Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com> Signed-off-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> --- charts/stable/qbitrr/docs/installation-notes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/charts/stable/qbitrr/docs/installation-notes.md b/charts/stable/qbitrr/docs/installation-notes.md index abd11d76f43..f294923f24a 100644 --- a/charts/stable/qbitrr/docs/installation-notes.md +++ b/charts/stable/qbitrr/docs/installation-notes.md @@ -18,7 +18,7 @@ You should also enable the codeserver addon as previously discussed. ## config.toml -Once qBitrr has started access the config.toml file using the previously configured `http://:` that was setup for the codeserver addon. +Once qBitrr has started access the `config.toml` file using the previously configured codeserver addon by surfing to the url `http://:/?folder=/config`. ### Settings @@ -32,11 +32,11 @@ If `CompletedDownloadFolder` option is not set to `"/completed_downloads"` qBitr ### qBit -This section has qBittorrent specific settings. Ensure that `Host`, `Port`, `UserName`, and `Password` all match your qBittorrent installation. The host and port can be located using the Heavyscript `heavyscript dns -a` command. +This section has qBittorrent specific settings. Ensure that `Host`, `Port`, `UserName`, and `Password` all match your qBittorrent installation. The host and port can be located using the Heavyscript `heavyscript dns -a` command to reveal the internal URL's (e.g.: `http://qbittorrent.ix-qbittorrent.svc.cluster.local`). ### Sonarr/Radarr -The following sections have Sonarr/Radarr specific settings. The template configuration file populates two instances for both Sonarr and Radarr by default. These can be renamed/deleted as needed to match your setup. Ensure that `URI`, `API` and `Category` are set correctly so that qBitrr can communicate with your Sonarr and Radarr installations. The `Category` is what you have set in Sonarr/Radarr to use in qBittorrent (ie. movies, tv). +The following sections have Sonarr/Radarr specific settings. The template configuration file populates two instances for both Sonarr and Radarr by default. These can be renamed/deleted as needed to match your setup. Ensure that `URI`, `API` and `Category` are set correctly so that qBitrr can communicate with your Sonarr and Radarr installation. You can find this by looking at the output of `heavyscript dns -a` again (e.g.: `URI = "http://sonarr.ix-sonarr.svc.cluster.local:8989/"`). The `Category` is what you have set in Sonarr/Radarr to use in qBittorrent (ie. movies, tv). ### Remaining Sonarr/Radarr Configurations