mirror of
https://github.com/ManiMatter/decluttarr.git
synced 2026-04-18 15:54:00 +02:00
125 lines
5.5 KiB
Plaintext
125 lines
5.5 KiB
Plaintext
################################# GENERAL SECTION #################################
|
||
# General parameters such as log level / test run
|
||
[general]
|
||
|
||
###### LOG_LEVEL ######
|
||
# Sets the level at which logging will take place
|
||
# INFO will only show changes applied to sonarr/radarr
|
||
# 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)
|
||
LOG_LEVEL = 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)
|
||
TEST_RUN = 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.
|
||
[features]
|
||
|
||
###### 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_TIMER = 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_FAILED = 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 sonarr/radarr (if available)
|
||
# Type: Boolean
|
||
# Permissible Values: True, False
|
||
# Is Mandatory: No (Defaults to False)
|
||
REMOVE_STALLED = 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 in the future
|
||
# A new download from another source is automatically added by sonarr/radarr (if available)
|
||
# Type: Boolean
|
||
# Permissible Values: True, False
|
||
# Is Mandatory: No (Defaults to False)
|
||
REMOVE_METADATA_MISSING = False
|
||
|
||
###### REMOVE_ORPHANS ######
|
||
# Steers whether orphan downloads are removed from the queue
|
||
# Orphan downloads are those that do not belong to any movie/TV show anymore (Since the movie/TV show was removed from sonarr/radarr 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_ORPHANS = False
|
||
|
||
###### REMOVE_UNMONITORED ######
|
||
# Steers whether downloads belonging to unmonitored movies/TV shows 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 the below NO_STALLED_REMOVAL_QBIT_TAG.
|
||
# Type: Boolean
|
||
# Permissible Values: True, False
|
||
# Is Mandatory: No (Defaults to False)
|
||
REMOVE_UNMONITORED = 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)
|
||
PERMITTED_ATTEMPTS = 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")
|
||
NO_STALLED_REMOVAL_QBIT_TAG = Don't Kill If Stalled
|
||
|
||
################################# RADARR SECTION #################################
|
||
[radarr]
|
||
# 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
|
||
RADARR_URL = http://localhost:7878
|
||
RADARR_KEY = $RADARR_API_KEY
|
||
|
||
################################# SONARR SECTION #################################
|
||
[sonarr]
|
||
# 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
|
||
SONARR_URL = http://localhost:8989
|
||
SONARR_KEY = $SONARR_API_KEY
|
||
|
||
################################# LIDARR SECTION #################################
|
||
[lidarr]
|
||
# 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
|
||
LIDARR_URL = http://lidarr:8686
|
||
LIDARR_KEY = $LIDARR_API_KEY
|
||
|
||
################################# QBITTORRENT SECTION #################################
|
||
[qbittorrent]
|
||
# 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: Optional; not needed if authentication bypassing on qBittorrent is enabled (for instance for local connections)
|
||
# QBITTORRENT_PASSWORD: Optional; same reason as above
|
||
QBITTORRENT_URL = http://localhost:8080
|
||
QBITTORRENT_USERNAME = Your name (or empty)
|
||
QBITTORRENT_PASSWORD = Your password (or empty) |