Decluttarr

Overview

Decluttarr keeps the radarr & sonarr & lidarr queue free of stalled / redundant downloads.

Feature overview:

• Automatically delete downloads that are stuck downloading metadata (& trigger download from another source)
• Automatically delete failed downloads (& trigger download from another source)
• Automatically delete downloads belonging to Movies/TV shows/Music requests that have been deleted in the meantime ('Orphan downloads')
• Automatically delete stalled downloads, after they have been found to be stalled multiple times in a row
• Automatically delete downloads belonging to Movies/TV shows/Music that are unmonitored

You may run this locally by launching main.py, or by pulling the docker image. You can find a sample docker-compose.yml in the docker folder.

Getting started

There's two ways to run this:

• As a docker container with docker-compose
• By cloning the repository and running the script manually

Both ways are explained below and there's an explanation for the different settings below that

Docker

1. Make a docker-compose.yml file
2. Use the following as a base for that and tweak the settings to your needs

version: "3.3"
services:
  decluttarr:
    image: "ghcr.io/fxsch/decluttarr:latest"   
    container_name: decluttarr
    restart: unless-stopped
    network_mode: "host"
    environment:
      - TZ=Europe/Berlin
      - PUID=1000
      - PGID=1000
      # General
      - LOG_LEVEL=INFO
      #- TEST_RUN=True 
      # Features 
      - REMOVE_TIMER=10
      - REMOVE_FAILED=True
      - REMOVE_STALLED=True
      - REMOVE_METADATA_MISSING=True     
      - REMOVE_ORPHANS=True
      - REMOVE_UNMONITORED=True
      - PERMITTED_ATTEMPTS=3
      - NO_STALLED_REMOVAL_QBIT_TAG=Don't Kill If Stalled
      # Radarr
      - RADARR_URL=http://localhost:7878
      - RADARR_KEY=$RADARR_API_KEY
      # Sonarr
      - SONARR_URL=http://localhost:8989
      - SONARR_KEY=$SONARR_API_KEY
      # Lidarr
      - LIDARR_URL=http://localhost:8686
      - LIDARR_KEY=$LIDARR_API_KEY
      # qBittorrent
      - QBITTORRENT_URL=http://localhost:8080
      #- QBITTORRENT_USERNAME=Your name
      #- QBITTORRENT_PASSWORD=Your password

3. Run docker-compose up -d in the directory where the file is located to create the docker container

Running manually

1. Clone the repository with git clone https://github.com/Fxsch/decluttarr.git
2. Tweak the config.conf file to your needs
3. Run the script with python3 main.py

Explanation of the settings

LOG_LEVEL

• Sets the level at which logging will take place
• INFO will only show changes applied to radarr/sonarr/lidarr
• VERBOSE will show when script runs (even if it results in no change)
• Type: String
• Permissible Values: CRITICAL, ERROR, WARNING, INFO, VERBOSE, DEBUG
• Is Mandatory: No (Defaults to INFO)

TEST_RUN

• Allows you to safely try out this tool. If active, downloads will not be removed.
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

---

Features settings

• Steers which type of cleaning is applied to the downloads queue
• Requires QUEUE_CLEANING to be set to True to take effect

REMOVE_TIMER

• Sets the frequency of how often the queue is checked for orphan and stalled downloads
• Type: Integer
• Unit: Minutes
• Is Mandatory: No (Defaults to 10)

REMOVE_FAILED

• Steers whether failed downloads with no connections are removed from the queue
• These downloads are not added to the blocklist
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

REMOVE_STALLED

• Steers whether stalled downloads with no connections are removed from the queue
• These downloads are added to the blocklist, so that they are not re-requested in the future - A new download from another source is automatically added by radarr/sonarr/lidarr (if available)
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

REMOVE_METADATA_MISSING

• Steers whether downloads stuck obtaining metadata are removed from the queue
• These downloads are added to the blocklist, so that they are not re-requested
• A new download from another source is automatically added by radarr/sonarr/lidarr (if available)
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

REMOVE_ORPHANS

• Steers whether orphan downloads are removed from the queue
• Orphan downloads are those that do not belong to any requested media anymore (Since the media was removed from radarr/sonarr/lidarr after the download started)
• These downloads are not added to the blocklist
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

REMOVE_UNMONITORED

• Steers whether downloads belonging to unmonitored media are removed from the queue
• Note: Will only remove from queue if all TV shows depending on the same download are unmonitored
• These downloads are not added to the blocklist
• Note: Since sonarr does not support multi-season packs, if you download one you should protect it with NO_STALLED_REMOVAL_QBIT_TAG that is explained further down
• Type: Boolean
• Permissible Values: True, False
• Is Mandatory: No (Defaults to False)

PERMITTED_ATTEMPTS

• Defines how many times a download has to be caught as stalled or stuck downloading metadata before it is removed
• Type: Integer
• Unit: Number of scans
• Is Mandatory: No (Defaults to 3)

NO_STALLED_REMOVAL_QBIT_TAG

• Downloads in qBittorrent tagged with this tag will not be killed even if they are stalled
• Tag is automatically created in qBittorrent (required qBittorrent is reachable on QBITTORRENT_URL)
• Also protects unmonitored downloads from being removed (relevant for multi-season packs)
• Type: String
• Is Mandatory: No (Defaults to Don't Kill If Stalled)

---

Radarr section

• Defines radarr instance on which download queue should be decluttered

RADARR_URL

• URL under which the instance can be reached
• If not defined, this instance will not be monitored

RADARR_KEY

• Your API key for radarr

---

Sonarr section

• Defines sonarr instance on which download queue should be decluttered

SONARR_URL

• URL under which the instance can be reached
• If not defined, this instance will not be monitored

SONARR_KEY

• Your API key for sonarr

---

Lidarr section

• Defines lidarr instance on which download queue should be decluttered

LIDARR_URL

• URL under which the instance can be reached
• If not defined, this instance will not be monitored

LIDARR_KEY

• Your API key for lidarr

---

qBittorrent section

• Defines settings to connect with qBittorrent

QBITTORRENT_URL

• URL under which the instance can be reached
• If not defined, the NO_STALLED_REMOVAL_QBIT_TAG takes no effect

QBITTORRENT_USERNAME

• Username used to log in to qBittorrent
• Optional; not needed if authentication bypassing on qBittorrent is enabled (for instance for local connections)

QBITTORRENT_PASSWORD

• Password used to log in to qBittorrent
• Optional; not needed if authentication bypassing on qBittorrent is enabled (for instance for local connections)

Credits

• ManiMatter for making this, I just forked it to fix some stuff
• Script for detecting stalled downloads expanded on code by MattDGTL/sonarr-radarr-queue-cleaner
• Script to read out config expanded on code by syncarr/syncarr
• SONARR/RADARR team & contributors for their great product, API documenation, and guidance in their Discord channel
• Particular thanks to them for adding an additional flag to their API that allowed this script detect downloads stuck finding metadata

Disclaimer

This script comes free of any warranty, and you are using it at your own risk.