kqmaverick
9e4de49ab4
**Description** Qbitrr has a logo now. ⚒️ Fixes # **⚙️ Type of change** - [X] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [ ] 📜 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 - [ ] 📄 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 - [X] ⬆️ 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. - [X] 🖼️ 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._
2.1 KiB
title
| title |
|---|
| Installation Notes |
This document will provide information on the successful setup of qBitrr.
qBitrr config.toml
Upon first run qBbitrr will download a config.toml file from the upstream developer. This file is just a template and will need to be modified before qBitrr begins operating. It is recommended that when configuring initial install to also enable the codeserver addon so that you can modify the config.toml file.
Settings
This section has basic qBitrr settings. You may modify any as you choose but the CompletedDownloadFolder option should be set to "/completed_downloads" as that is what the values.yaml is mapped to.
// values.yaml
persistence:
downloads:
enabled: true
type: nfs
path: /mnt/data/media/downloads
mountPath: /completed_downloads
server: 192.168.0.100
:::caution[Completed Download Folder]
If CompletedDownloadFolder option is not set for the download directory of qbittorrent then qbitrr will not work. We recommend sticking with the setup as described above.
:::
qBit
This section has qBittorrent specific settings. Ensure that Host, Port, UserName, and Password all match your qBittorrent installation. We recommend using internal URL's (e.g.: http://qbittorrent.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/duplicated as needed to match your setup (any number os Sonarr/Radarr instances are supported). Ensure that URI, API and Category are set correctly so that qBitrr can communicate with your Sonarr and Radarr installation. You should use the internal URL again (e.g.: URI = "http://sonarr.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
All of the following sections can be configured based on personal preference. If you chose to rename or delete any of the predefined templates ensure you follow the same schema for the remaining sections.