A simple script to monitor qBit and communicate with Radarr and Sonarr
I am starting development on qBitrr+ which will be C# based for better overall performance and will also include a WebUI for better refined control on setting and what to search/upgrade etc. Hoping this will be the be all and end all application to manage your Radarr/Sonarr, Overseerr/Ombi and qBittorrent instances in one UI. This is still in it's very early stages and will likely be a couple months before a concrete alpha is rolled out (from start of February 2024). Once I have something solid I will remove this notice and add a link to the new qBitrr+, in the meantime I will be sharing periodic updates on my Patreon
qbitrr DownloadedMoviesScan
for Radarrqbitrr DownloadedEpisodesScan
for SonarrSome things to know before using it.
python -m pip install qBitrr2
(I would recommend in a dedicated venv but that's out of scope.Alternatively:
qBitrr2
to generate a config file~/config/config.toml
(~ is your current directory)qBitrr2
if installed through pip again to start the scriptAlternatively:
qBitrr
to generate a config file~/config/config.toml
(~ is your current directory)qBitrr
if installed through pip again to start the scriptpython -m pip install -U qBitrr2
Alternatively:
qBitrr
to generate a config file~/config/config.toml
(~ is your current directory)qBitrr
if installed through pip again to start the scriptThere is no auto-update feature, you will need to manually download the latest release and replace the old one.
docker run -d \
--name=qbitrr \
-e TZ=Europe/London \
-v /etc/localtime:/etc/localtime:ro \
-v /path/to/appdata/qbitrr:/config \
-v /path/to/completed/downloads/folder:/completed_downloads:rw \
--restart unless-stopped \
feramance/qbitrr:latest
version: "3"
services:
qbitrr:
image: feramance/qbitrr:latest
user: 1000:1000 # Required to ensure the container is run as the user who has perms to see the 2 mount points and the ability to write to the CompletedDownloadFolder mount
tty: true # Ensure the output of docker-compose logs qBitrr are properly colored.
restart: unless-stopped
# networks: This container MUST share a network with your Sonarr/Radarr instances
environment:
- TZ=Europe/London
volumes:
- /etc/localtime:/etc/localtime:ro
- /path/to/appdata/qbitrr:/config # Config folder for qBitrr
- /path/to/completed/downloads/folder:/completed_downloads:rw # The script will ALWAYS require write permission in this folder if mounted, this folder is used to monitor completed downloads and if not present will cause the script to ignore downloaded file monitoring.
# Now just to make sure it is clean, when using this script in a docker you will need to ensure you config.toml values reflect the mounted folders.
# The same would apply to Settings.CompletedDownloadFolder
# e.g CompletedDownloadFolder = /completed_downloads/folder/in/container
logging: # this script will generate a LOT of logs - so it is up to you to decide how much of it you want to store
driver: "json-file"
options:
max-size: "50m"
max-file: 3
depends_on: # Not needed but this ensures qBitrr only starts if the dependencies are up and running
- qbittorrent
- radarr-1080p
- radarr-4k
- sonarr-1080p
- sonarr-anime
- overseerr
- ombi
/path/to/appdata/qbitrr
Please do not hesitate to open an issue for feature requests or any suggestions you may have. I plan on periodically adding any features I might feel I want to add but welcome to other suggestions I might not have thought of yet.
When reporting an issue, please ensure that log files are enabled while running qBitrr and attach them to the issue. Thank you.