docs(qbittorrent): helmify docs (#32949)

**Description**  ⚒️ Fixes #  **⚙️ 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 - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?**  **📃 Notes:**  **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 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 changes to the documentation - [ ] 🧪 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 - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ 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._ --------- Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> Co-authored-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>
2025-03-06 18:43:21 +00:00
parent 9ac364edec
commit 1e0dcbb8c6
12 changed files with 35 additions and 60 deletions
@@ -2,42 +2,26 @@
 title: Installation Guide
 ---

-## Dataset Structure
+## Chart configuration

-This is the location your completed bittorrent files will be located
+### Dataset Structure

-Setting user:group to `apps`.
+You need to add a pesistence, for where your completed bittorrent files can be stores. For examle a NFS share:

-:::note
-
-The `apps`:`apps` user:group is built into Truenas SCALE, it is the default user for most applications on Truenas SCALE.
-You do not have to create a separate user for each application.
-
-When configuring your application you'll typically see user:group `568`, this is the UID for `apps` and its recommended not to change it.
-
-:::
-
-![!Dataset: Tube](./img/dataset.png)
-
-<br />
-
-## App Installation
+```yaml
+persistence:
+  data:
+    type: nfs
+    # Example NFS Share
+    server: "192.168.0.10"
+    path: "/qbitvpn/"
+```

 ### Networking

-If you want to use ingress, its probably better to use `clusterIP` instead of `LoadBalancer`
+Add an `loadBalancerIP` to the `main` service or configure an Ingress if you prefer. Common documentation can be checked for more information.

-![!Networking: qbittorrent](./img/networking.png)
-
-#### WebGUI
-
-We left this default since there was no reason to change the WebGUI port
-
-This is ALSO the port Sonarr/Radarr and other services will use to connect to qBittorrent
-
-![!Networking: qbittorrent](./img/networking_webgui.png)
-
-#### Listening Ports
+### Listening Ports

 :::tip[VPN "With VPN"]

@@ -54,29 +38,19 @@ This is ALSO the port Sonarr/Radarr and other services will use to connect to qB

 :::

-![!Networking: qbittorrent](./img/networking_listening.png)
+An loadBalancer IP must assigned to the `Listening` port. Standard configures as port `6881` 

-<br />
-
-### Storage
-
-#### Configuration
-
-The setup is default
-
-![!Storage: qbittorrent](./img/storage_config.png)
-
-#### Data
-
-I always mount to the root directory of the container
-
-![!Storage: qbittorrent](./img/storage_data.png)
-
-<br />
+```yaml
+service:
+  torrent:
+    enabled: true
+    type: LoadBalancer
+    loadBalancerIP: 192.168.1.230
+```

 ### VPN

-Use the [Gluetun VPN Add-on Setup Guide](/
+Use the [Gluetun VPN Add-on Setup Guide](https://truecharts.org/guides/addons/vpn-setup/)

 <br />

@@ -142,7 +116,7 @@ Added both my LAN and Kubernetes LAN to the bypass list, this way neither of the

 ![!Speed: qbit](./img/settings_webgui1.png)

-Since We am using `Traefik`, We decided to add the Kubernetes LAN to:
+Add the Kubernetes LAN to:

 **Enable reverse proxy support**

@@ -2,12 +2,5 @@
 title: Initial Password
 ---

-As of qBittorrent 4.6.1 the default password of `adminadmin` is no longer used. If you previously used this password or are completing a new installation of qBittorent you will now have a randomly generated password. This guide will show you how to locate this randomly generated password.
-
-1. With qBittorent selected in the application window select the logs button.
-   ![qbittorrent-logs](./img/qbittorrent-logs.png)
-2. In the `Choose Pod` windows ensure the qBittorent Pod and Container is selected and click `Choose`.
-   ![qbittorent-logs2](./img/qbittorrent-logs2.png)
-3. In the `Information` section of the logs take note of the randomly generated password.
-   ![qbittorent-password](./img/qbittorrent-password.png)
-4. Use the randomly generated password to login to the WebUI. You must change it in the qBittorent settings after you login as it will generate a new random password each time qBittorent is started until a password is set.
+As of qBittorrent 4.6.1 the default password of `adminadmin` is no longer used. If you previously used this password or are completing a new installation of qBittorent you will now have a randomly generated password.
+This password will be given in the POD logs when deployed for the first time.
@@ -10,6 +10,14 @@ qBittorrent will fail to start if Gluetun is not configured for use with port fo

 :::

-To enable automatic port forwarding check the box `Gluetun Port Forwarding` in the qBittorrent App Configuration section.
-
 You are required to provide the qBittorrent WebUI username and password. Because of this requirement you _CANNOT_ enable this feature until you have completed the installation of qBittorrent and configured the WebUI username and password in the qBittorrent settings first.
+
+To enable automatic port forwarding add to your `.Values`:
+
+```yaml
+qbitportforward:
+  enabled: true
+  QBT_USERNAME: "admin"
+  QBT_PASSWORD: "adminadmin"
+```
+