mirror of
https://github.com/StuffAnThings/qbit_manage.git
synced 2024-09-20 15:26:02 +08:00
f9ab961100
- update tag reactions so all notifiarr default supported are covered - formatting - add additional details for webhooks & notifiarr - add comment indicating this is an example file and will need to be modified
173 lines
6.6 KiB
Plaintext
173 lines
6.6 KiB
Plaintext
# This is an example configuration file that documents all the options.
|
|
# It will need to be modified for your specific use case.
|
|
|
|
# qBittorrent parameters
|
|
qbt:
|
|
host: "localhost:8080"
|
|
user: "username"
|
|
pass: "password"
|
|
|
|
directory:
|
|
# Do not remove these
|
|
# Cross-seed var: </your/path/here/> # Output directory of cross-seed
|
|
# root_dir var: </your/path/here/> # Root downloads directory used to check for orphaned files, noHL, and RecycleBin.
|
|
# <OPTIONAL> remote_dir var: </your/path/here/> # Path of docker host mapping of root_dir.
|
|
# Must be set if you're running qbit_manage locally and qBittorrent/cross_seed is in a docker
|
|
cross_seed: "/your/path/here/"
|
|
root_dir: "/data/torrents/"
|
|
remote_dir: "/mnt/user/data/torrents/"
|
|
|
|
# Category & Path Parameters
|
|
cat:
|
|
# <Category Name> : <save_path> # Path of your save directory. Can be a keyword or full path
|
|
movies: "/data/torrents/Movies"
|
|
tv: "TV"
|
|
|
|
# Tag Parameters
|
|
tags:
|
|
# <Tracker URL Keyword>: # <MANDATORY> This is the keyword in the tracker url
|
|
# <MANDATORY> Set tag name
|
|
# tag: <Tag Name>
|
|
# <OPTIONAL> Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading. -2 means the global limit should be used, -1 means no limit.
|
|
# max_ratio: 5.0
|
|
# <OPTIONAL> Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding. -2 means the global limit should be used, -1 means no limit.
|
|
# max_seeding_time: 129600
|
|
# <OPTIONAL> Will limit the upload speed KiB/s (KiloBytes/second) (-1 sets the limit to infinity)
|
|
# limit_upload_speed: 150
|
|
# <OPTIONAL> Set this to the notifiarr react name. This is used to add indexer reactions to the notifications sent by Notifiarr
|
|
# notifiarr: <notifiarr indexer>
|
|
animebytes.tv:
|
|
tag: AnimeBytes
|
|
notifiarr: animebytes
|
|
avistaz:
|
|
tag: Avistaz
|
|
max_ratio: 5.0
|
|
max_seeding_time: 129600
|
|
limit_upload_speed: 150
|
|
notifiarr: avistaz
|
|
beyond-hd:
|
|
tag: Beyond-HD
|
|
notifiarr: beyondhd
|
|
blutopia:
|
|
tag: Blutopia
|
|
notifiarr: blutopia
|
|
cartoonchaos:
|
|
tag: CartoonChaos
|
|
digitalcore:
|
|
tag: DigitalCore
|
|
max_ratio: 5.0
|
|
notifiarr: digitalcore
|
|
gazellegames:
|
|
tag: GGn
|
|
limit_upload_speed: 150
|
|
hdts:
|
|
tag: HDTorrents
|
|
max_seeding_time: 129600
|
|
landof.tv:
|
|
tag: BroadcasTheNet
|
|
notifiarr: broadcasthenet
|
|
myanonamouse:
|
|
tag: MaM
|
|
passthepopcorn:
|
|
tag: PassThePopcorn
|
|
notifiarr: passthepopcorn
|
|
privatehd:
|
|
tag: PrivateHD
|
|
notifiarr:
|
|
tleechreload:
|
|
tag: TorrentLeech
|
|
notifiarr: torrentleech
|
|
torrentdb:
|
|
tag: TorrentDB
|
|
notifiarr: torrentdb
|
|
torrentleech:
|
|
tag: TorrentLeech
|
|
notifiarr: torrentleech
|
|
tv-vault:
|
|
tag: TV-Vault
|
|
|
|
# Tag Movies/Series that are not hard linked
|
|
nohardlinks:
|
|
# Mandatory to fill out directory parameter above to use this function (root_dir/remote_dir)
|
|
# This variable should be set to your category name of your completed movies/completed series in qbit. Acceptable variable can be any category you would like to tag if there are no hardlinks found
|
|
movies-completed:
|
|
#<OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
|
|
exclude_tags:
|
|
- Beyond-HD
|
|
- AnimeBytes
|
|
- MaM
|
|
#<OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
|
|
cleanup: false
|
|
#<OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
|
|
max_ratio: 4.0
|
|
#<OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
|
|
max_seeding_time: 86400
|
|
|
|
# Can have additional categories set with separate ratio/seeding times defined.
|
|
series-completed:
|
|
#<OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
|
|
exclude_tags:
|
|
- Beyond-HD
|
|
- BroadcasTheNet
|
|
#<OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
|
|
cleanup: false
|
|
#<OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
|
|
max_ratio: 4.0
|
|
#<OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
|
|
max_seeding_time: 86400
|
|
|
|
# Recycle Bin method of deletion will move files into the recycle bin (Located in /root_dir/.RecycleBin) instead of directly deleting them in qbit
|
|
# By default the Recycle Bin will be emptied on every run of the qbit_manage script if empty_after_x_days is defined.
|
|
recyclebin:
|
|
enabled: true
|
|
#<OPTIONAL> empty_after_x_days var: Will automatically remove all files and folders in recycle bin after x days. (Checks every script run)
|
|
# If this variable is not defined it, the RecycleBin will never be emptied.
|
|
# WARNING: Setting this variable to 0 will delete all files immediately upon script run!
|
|
empty_after_x_days: 60
|
|
|
|
# Orphaned files are those in the root_dir download directory that are not referenced by any active torrents.
|
|
orphaned:
|
|
# File patterns that will not be considered orphaned files. Handy for generated files that aren't part of the torrent but belong with the torrent's files
|
|
exclude_patterns:
|
|
- "**/.DS_Store"
|
|
- "**/Thumbs.db"
|
|
- "**/@eaDir"
|
|
- "/data/torrents/temp/**"
|
|
- "**/*.!qB"
|
|
|
|
# Apprise integration with webhooks
|
|
# Leave Empty/Blank to disable
|
|
apprise:
|
|
# Mandatory to fill out the url of your apprise API endpoint
|
|
api_url: http://apprise-api:8000
|
|
# Mandatory to fill out the notification url/urls based on the notification services provided by apprise. https://github.com/caronc/apprise/wiki
|
|
notify_url:
|
|
|
|
# Notifiarr integration with webhooks
|
|
# Leave Empty/Blank to disable
|
|
notifiarr:
|
|
# Mandatory to fill out API Key
|
|
apikey: ####################################
|
|
#<OPTIONAL> Set to a unique value (could be your username on notifiarr for example)
|
|
instance:
|
|
|
|
# Webhook notifications:
|
|
# Possible values:
|
|
# Set value to notifiarr if using notifiarr integration
|
|
# Set value to apprise if using apprise integration
|
|
# Set value to a valid webhook URL
|
|
# Leave Empty/Blank to disable
|
|
webhooks:
|
|
error: https://mywebhookurl.com/qbt_manage
|
|
run_start: notifiarr
|
|
run_end: apprise
|
|
function:
|
|
cross_seed: https://mywebhookurl.com/qbt_manage
|
|
recheck: notifiarr
|
|
cat_update: apprise
|
|
tag_update: notifiarr
|
|
rem_unregistered: notifiarr
|
|
rem_orphaned: notifiarr
|
|
tag_nohardlinks: notifiarr
|
|
empty_recyclebin: notifiarr
|