mirror of
https://github.com/truecharts/charts.git
synced 2026-07-28 08:14:31 -03:00
docs(qbittorrent): add auto port forward docs (#15348)
**Description** Adds documentation describing automatic port forwarding sidecar. ⚒️ 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 **🧪 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 - [ ] 📄 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` --- _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._
This commit is contained in:
13
charts/stable/qbittorrent/docs/port-forwarding.md
Normal file
13
charts/stable/qbittorrent/docs/port-forwarding.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Automatic Gluetun Port Forwarding
|
||||
|
||||
qBittorrent can be configured to automatically utilize the VPN forward port when used with Gluetun.
|
||||
|
||||
:::danger GLUETUN PORT FORWARDING REQUIRED
|
||||
|
||||
qBittorrent will fail to start if Gluetun is not configured for use with port forwarding enabled.
|
||||
|
||||
:::
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user