mirror of
https://github.com/StuffAnThings/qbit_manage.git
synced 2025-09-11 15:45:42 +08:00
adds cat_changes addition to config
bobokun
parent
70da045be3
commit
a3214b9a3c
5 changed files with 45 additions and 20 deletions
|
|
@ -7,7 +7,7 @@
|
|||
| `-lf LOGFILE,` or `--log-file LOGFILE,` | QBT_LOGFILE | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log |
|
||||
| `-cs` or `--cross-seed` | QBT_CROSS_SEED | Use this after running [cross-seed script](https://github.com/mmgoodnow/cross-seed) to add torrents from the cross-seed output folder to qBittorrent | False |
|
||||
| `-re` or `--recheck` | QBT_RECHECK | Recheck paused torrents sorted by lowest size. Resume if Completed. | False |
|
||||
| `-cu` or `--cat-update` | QBT_CAT_UPDATE | Use this if you would like to update your categories. | False |
|
||||
| `-cu` or `--cat-update` | QBT_CAT_UPDATE | Use this if you would like to update your categories or move from one category to another. | False |
|
||||
| `-tu` or `--tag-update` | QBT_TAG_UPDATE | Use this if you would like to update your tags and/or set seed goals/limit upload speed by tag. (Only adds tags to untagged torrents) | False |
|
||||
| `-ru` or `--rem-unregistered` | QBT_REM_UNREGISTERED | Use this if you would like to remove unregistered torrents. (It will the delete data & torrent if it is not being cross-seeded, otherwise it will just remove the torrent without deleting data). Trackers that have an error and not covered by the remove unregistered logic will also be tagged as `issue` for manual review.| False |
|
||||
| `-tte` or `--tag-tracker-error` | QBT_TAG_TRACKER_ERROR | Use this if you would like to tag torrents that do not have a working tracker. | False |
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ A template Configuration File can be found in the repo [config/config.yml.sample
|
|||
# Please refer to the link below for more details on how to set up the configuration file
|
||||
# https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup
|
||||
|
||||
# qBittorrent parameters
|
||||
qbt:
|
||||
# qBittorrent parameters
|
||||
host: "localhost:8080"
|
||||
user: "username"
|
||||
pass: "password"
|
||||
|
|
@ -46,14 +46,24 @@ directory:
|
|||
recycle_bin: "/mnt/user/data/torrents/.RecycleBin"
|
||||
torrents_dir: "/qbittorrent/data/BT_backup"
|
||||
|
||||
# Category & Path Parameters
|
||||
cat:
|
||||
# Category & Path Parameters
|
||||
# <Category Name> : <save_path> # Path of your save directory.
|
||||
movies: "/data/torrents/Movies"
|
||||
tv: "/data/torrents/TV"
|
||||
|
||||
# Tag Parameters
|
||||
cat_change:
|
||||
# This moves all the torrents from one category to another category. This executes on --cat-update
|
||||
# WARNING: if the paths are different and Default Torrent Management Mode is set to automatic the files could be moved !!!
|
||||
# <Old Category Name> : <New Category>
|
||||
Radarr-HD.cross-seed: movies-hd
|
||||
Radarr-UHD.cross-seed: movies-uhd
|
||||
movies-hd.cross-seed: movies-hd
|
||||
movies-uhd.cross-seed: movies-uhd
|
||||
|
||||
|
||||
tracker:
|
||||
# Tag Parameters
|
||||
# <Tracker URL Keyword>: # <MANDATORY> This is the keyword in the tracker url
|
||||
# <MANDATORY> Set tag name. Can be a list of tags or a single tag
|
||||
# tag: <Tag Name>
|
||||
|
|
@ -118,8 +128,8 @@ tracker:
|
|||
tv-vault:
|
||||
tag: TV-Vault
|
||||
|
||||
# Tag Movies/Series that are not hard linked
|
||||
nohardlinks:
|
||||
# Tag Movies/Series that are not hard linked
|
||||
# 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:
|
||||
|
|
@ -156,9 +166,9 @@ nohardlinks:
|
|||
# <OPTIONAL> min seeding time var: Will ensure that torrent is not deleted by cleanup variable if torrent does not meet minimum seeding time (min).
|
||||
min_seeding_time: 43200
|
||||
|
||||
# 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:
|
||||
# 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.
|
||||
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)
|
||||
|
|
@ -174,8 +184,8 @@ recyclebin:
|
|||
# and add the base folder name of the recycle bin that was defined in the `recycle_bin` sub-attribute under directory.
|
||||
split_by_category: false
|
||||
|
||||
# Orphaned files are those in the root_dir download directory that are not referenced by any active torrents.
|
||||
orphaned:
|
||||
# Orphaned files are those in the root_dir download directory that are not referenced by any active torrents.
|
||||
# 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"
|
||||
|
|
@ -184,29 +194,29 @@ orphaned:
|
|||
- "/data/torrents/temp/**"
|
||||
- "**/*.!qB"
|
||||
|
||||
# Apprise integration with webhooks
|
||||
# Leave Empty/Blank to disable
|
||||
apprise:
|
||||
# Apprise integration with webhooks
|
||||
# Leave Empty/Blank to disable
|
||||
# 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:
|
||||
# Notifiarr integration with webhooks
|
||||
# Leave Empty/Blank to disable
|
||||
# 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:
|
||||
# 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
|
||||
error: https://mywebhookurl.com/qbt_manage
|
||||
run_start: notifiarr
|
||||
run_end: apprise
|
||||
|
|
@ -221,8 +231,8 @@ webhooks:
|
|||
tag_nohardlinks: notifiarr
|
||||
empty_recyclebin: notifiarr
|
||||
|
||||
# BHD Integration used for checking unregistered torrents
|
||||
bhd:
|
||||
# BHD Integration used for checking unregistered torrents
|
||||
apikey:
|
||||
```
|
||||
# **List of variables**<br>
|
||||
|
|
@ -274,7 +284,20 @@ The syntax for all the categories are as follows
|
|||
```yaml
|
||||
category: <path>/<to>/category
|
||||
```
|
||||
## **cat_changes:**
|
||||
---
|
||||
This moves all the torrents from one category to another category if the torrents are marked as complete.<br>
|
||||
> **NOTE** **WARNING**: if the paths are different and Default Torrent Management Mode is set to automatic the files could be moved !!!
|
||||
|
||||
| Configuration | Definition | Required
|
||||
| :------------ | :------------ | :------------
|
||||
| `key`| Name of the original category|<center>✅</center>
|
||||
| `value` | Name of the new category| <center>✅</center>
|
||||
|
||||
The syntax for the categories are as follows
|
||||
```yaml
|
||||
old_category_name: new_category_name
|
||||
```
|
||||
## **tracker:**
|
||||
---
|
||||
This section defines the tags used based upon the tracker's URL.<br>
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Below is a list of the docker enviroment variables
|
|||
| QBT_LOGFILE | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log |
|
||||
| QBT_CROSS_SEED | Use this after running [cross-seed script](https://github.com/mmgoodnow/cross-seed) to add torrents from the cross-seed output folder to qBittorrent | False |
|
||||
| QBT_RECHECK | Recheck paused torrents sorted by lowest size. Resume if Completed. | False |
|
||||
| QBT_CAT_UPDATE | Use this if you would like to update your categories. | False |
|
||||
| QBT_CAT_UPDATE | Use this if you would like to update your categories or move from one category to another.. | False |
|
||||
| QBT_TAG_UPDATE | Use this if you would like to update your tags. (Only adds tags to untagged torrents) | False |
|
||||
| QBT_REM_UNREGISTERED | Use this if you would like to remove unregistered torrents. (It will the delete data & torrent if it is not being cross-seeded, otherwise it will just remove the torrent without deleting data) | False |
|
||||
| QBT_REM_ORPHANED | Use this if you would like to remove orphaned files from your `root_dir` directory that are not referenced by any torrents. It will scan your `root_dir` directory and compare it with what is in qBittorrent. Any data not referenced in qBittorrent will be moved into `/data/torrents/orphaned_data` folder for you to review/delete. | False |
|
||||
|
|
|
|||
1
Home.md
1
Home.md
|
|
@ -28,6 +28,7 @@ This wiki should tell you everything you need to know about the script to get it
|
|||
- [settings](Config-Setup#settings)
|
||||
- [directory](Config-Setup#directory)
|
||||
- [cat](Config-Setup#cat)
|
||||
- [cat_changes](Config-Setup#cat_changes)
|
||||
- [tracker](Config-Setup#tracker)
|
||||
- [nohardlinks](Config-Setup#nohardlinks)
|
||||
- [recyclebin](Config-Setup#recyclebin)
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@
|
|||
- [settings](Config-Setup#settings)
|
||||
- [directory](Config-Setup#directory)
|
||||
- [cat](Config-Setup#cat)
|
||||
- [cat_changes](Config-Setup#cat_changes)
|
||||
- [tracker](Config-Setup#tracker)
|
||||
- [nohardlinks](Config-Setup#nohardlinks)
|
||||
- [recyclebin](Config-Setup#recyclebin)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue