starred/decluttarr
1
0
Fork 0
mirror of https://github.com/ManiMatter/decluttarr.git synced 2026-04-18 17:54:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated config.conf-Explained to fix typos, make it more consistent and easier to understand

Browse Source
This commit is contained in:
Nico Janzen
2024-02-04 22:52:52 +01:00
parent fb79251264
commit 14dd059c3a
1 changed files with 39 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
config/config.conf-Explained
View File

@@ -1,13 +1,10 @@
# The config file is only relevant when running main.py locally.
# When running within docker, all settings are to be set via the docker-compose.yml, and this config.conf file will be ignored
################################# 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 Radarr/Sonarr
# 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
@@ -27,7 +24,7 @@ TEST_RUN = False
[features]
###### REMOVE_TIMER ######
# Sets the frequency how often the queue is cleaned form orphan and stalled downloads
# 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)
@@ -35,96 +32,94 @@ REMOVE_TIMER = 10
###### REMOVE_FAILED ######
# Steers whether failed downloads with no connections are removed from the queue
# Failed downloads are not added to the blocklist
# These downloads are not added to the blocklist
# Type: Boolean
# Permissible Values: True, False
# Is Mandatory: No (Defaults to False)
REMOVE_FAILED = False
REMOVE_FAILED = False
###### REMOVE_STALLED ######
# Steers whether stalled downloads with no connections are removed from the queue
# Stalled downloads are added to the blocklist, so that they are not re-requested in the future
# 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_STALLED = False
###### REMOVE_METADATA_MISSING ######
# Steers whether downloads stuck obtaining meta data are removed from the queue
# These downloads are added the blocklist, so that they are not re-requested in the future
# 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_METADATA_MISSING = False
###### REMOVE_ORPHANS ######
# Steers whether orphan downloads are removed from the queue
# Orphan downloads those that do not belong to any movie/tvshow anymore (since the movie/TV show was deleted post request)
# Orphan downloads are not added to the block list
# 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_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
# Unmonitored downloads are not added to the block list
# 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.
# 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
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
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 )
# 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
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 : API Key (mandatory if RADARR_URL is specifidd)
RADARR_URL = http://radarrA:7878
RADARR_KEY = XXXXX
# 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]
# Please see the documentation under the RADARR section - the explanations the same.
SONARR_URL = http://sonarr:8989
SONARR_KEY = XXXXX
# 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
################################# SONARR SECTION #################################
[sonarr]
# Please see the documentation under the RADARR section - the explanations the same.
SONARR_URL = http://sonarr:8989
SONARR_KEY = XXXXX
################################# SONARR SECTION #################################
################################# LIDARR SECTION #################################
[lidarr]
# Please see the documentation under the RADARR section - the explanations the same.
LIDARR_URL = http://lidarr:8686
LIDARR_KEY = XXXXX
# 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; particularly not needed if authentication bypassing on qBittorrent is enabled (for instance for local connections)
# 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://qbittorrent:8080
QBITTORRENT_USERNAME = Your Name (or empty)
QBITTORRENT_PASSWORD = Your Password (or empty)
QBITTORRENT_URL = http://localhost:8080
QBITTORRENT_USERNAME = Your Name (or empty)
QBITTORRENT_PASSWORD = Your Password (or empty)