46 lines
2.6 KiB
Markdown
46 lines
2.6 KiB
Markdown
---
|
|
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.
|
|
|
|
## qBitrr Application Configurations
|
|
|
|
Most of the configurations can remain the default. You will need to map your qBittorrent root download directory to App Completed Download Storage as shown below.
|
|
|
|
|
|
|
|
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 codeserver addon by surfing to the url `http://<ip address>:<port>/?folder=/config`.
|
|
|
|
### Settings
|
|
|
|
This section has basic qBitrr settings. You may modify any as you choose but the `CompletedDownloadFolder` option must be set to `"/completed_downloads"` as that is what the App Completed Download Storage is mapped to.
|
|
|
|
:::caution[Completed Download Folder]
|
|
|
|
If `CompletedDownloadFolder` option is not set to `"/completed_downloads"` qBitrr will not be able to find any downloads.
|
|
|
|
:::
|
|
|
|
### 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 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/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 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
|
|
|
|
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.
|