Skip to content

Commit

Permalink
update wiki with new settings
Browse files Browse the repository at this point in the history
  • Loading branch information
bobokun committed Jan 11, 2022
1 parent 61559a7 commit a1c7f41
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 4 deletions.
4 changes: 3 additions & 1 deletion Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
| :------------ | :------------ | :------------ | :------------ |
| `-r` or`--run` | QBT_RUN |Run without the scheduler. Script will exit after completion. | False |
| `-sch` or `--schedule` | QBT_SCHEDULE | Schedule to run every x minutes. (Default set to 1440 (1 day)) | 1440 |
| `-sd` or `--startup-delay` | QBT_STARTUP_DELAY | Set delay in seconds on the first run of a schedule (Default set to 0) | 0 |
| `-c CONFIG` or `--config-file CONFIG` | QBT_CONFIG | This is used if you want to use a different name for your config.yml. `Example: tv.yml` | config.yml |
| `-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 |
| `-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). Potential unregistered torrents that have an error will also be tagged as `issue` for manual review.| 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 |
| `-ro` or `--rem-orphaned` | 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 |
| `-tnhl` or `--tag-nohardlinks` | QBT_TAG_NOHARDLINKS | Use this to tag any torrents that do not have any hard links associated with any of the files. This is useful for those that use Sonarr/Radarr that hard links your media files with the torrents for seeding. When files get upgraded they no longer become linked with your media therefore will be tagged with a new tag noHL. You can then safely delete/remove these torrents to free up any extra space that is not being used by your media folder. | False |
| `-sr` or `--skip-recycle` | QBT_SKIP_RECYCLE | Use this to skip emptying the Reycle Bin folder (`/root_dir/.RecycleBin`). | False |
Expand Down
31 changes: 28 additions & 3 deletions Config-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,16 @@ This section defines your qBittorrent instance.

<br>

## **settings:**
---
This section defines any settings defined in the configuration.

| Variable | Definition | Required
| :------------ | :------------ | :------------
| `force_auto_tmm`| Will force qBittorrent to enable Automatic Torrent Management for each torrent.|<center>❌</center>
| `tracker_error_tag` | Define the tag of any torrents that do not have a working tracker. (Used in `--rem-unregistered` and `--tag-tracker-error`| <center>❌</center>

<br>
## **directory:**
---
This section defines the directories that qbit_manage will be looking into for various parts of the script.
Expand Down Expand Up @@ -357,6 +367,7 @@ Provide webhook notifications based on event triggers
|[cat_update](#category-update-notifications)| During the category update function | N/A | <center>❌</center>
|[tag_update](#tag-update-notifications)| During the tag update function | N/A | <center>❌</center>
|[rem_unregistered](#remove-unregistered-torrents-notifications)| During the removing unregistered torrents function | N/A | <center>❌</center>
|[tag_tracker_error](#tag-tracker-error-notifications)| During the removing unregistered torrents/tag tracker error function | N/A | <center>❌</center>
|[rem_orphaned](#remove-orphaned-files-notifications)| During the removing orphaned function| N/A | <center>❌</center>
|[tag_nohardlinks](#tag-no-hardlinks-notifications)| During the tag no hardlinks function | N/A | <center>❌</center>
|[empty_recyclebin](#empty-recycle-bin-notifications)| When files are deleted from the Recycle Bin | N/A | <center>❌</center>
Expand Down Expand Up @@ -403,7 +414,8 @@ Payload will be sent at the end of the run
"torrents_categorized": int, // Total Torrents Categorized
"torrents_tagged": int, // Total Torrents Tagged
"remove_unregistered": int, // Total Unregistered Torrents Removed
"potential_unregistered ": int, // Total Potential Unregistered Torrents Found
"torrents_tagged_tracker_error": int, // Total Tracker Error Torrents Tagged
"torrents_untagged_tracker_error": int, // Total Tracker Error Torrents untagged
"orphaned_files_found": int, // Total Orphaned Files Found
"torrents_tagged_no_hardlinks": int, // Total noHL Torrents Tagged
"torrents_untagged_no_hardlinks": int, // Total noHL Torrents untagged
Expand Down Expand Up @@ -496,10 +508,11 @@ Payload will be sent when Unregistered Torrents are found
"notifiarr_indexer": str, // Notifiarr React name/id for indexer
}
```
Payload will be sent when Potential Unregistered Torrents are found
### **Tag Tracker Error Notifications**
Payload will be sent when trackers with errors are tagged/untagged
```yaml
{
"function": "potential_rem_unregistered", // Webhook Trigger keyword
"function": "tag_tracker_error", // Webhook Trigger keyword
"title": str, // Title of the Payload
"body": str, // Message of the Payload
"torrent_name": str, // Torrent Name
Expand All @@ -510,6 +523,18 @@ Payload will be sent when Potential Unregistered Torrents are found
"notifiarr_indexer": str, // Notifiarr React name/id for indexer
}
```
```yaml
{
"function": "untag_tracker_error", // Webhook Trigger keyword
"title": str, // Title of the Payload
"body": str, // Message of the Payload
"torrent_name": str, // Torrent Name
"torrent_category": str, // Torrent Category
"torrent_tag": "issue", // Tag Added
"torrent_tracker": str, // Torrent Tracker URL
"notifiarr_indexer": str, // Notifiarr React name/id for indexer
}
```

### **Remove Orphaned Files Notifications**
Payload will be sent when Orphaned Files are found and moved into the orphaned folder
Expand Down
1 change: 1 addition & 0 deletions Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ This wiki should tell you everything you need to know about the script to get it
- [Sample Config File](Config-Setup#config-file)
- [List of variables](Config-Setup#list-of-variables)
- [qbt](Config-Setup#qbt)
- [settings](Config-Setup#settings)
- [directory](Config-Setup#directory)
- [cat](Config-Setup#cat)
- [tracker](Config-Setup#tracker)
Expand Down
1 change: 1 addition & 0 deletions _Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Sample Config File](Config-Setup#config-file)
- [List of variables](Config-Setup#list-of-variables)
- [qbt](Config-Setup#qbt)
- [settings](Config-Setup#settings)
- [directory](Config-Setup#directory)
- [cat](Config-Setup#cat)
- [tracker](Config-Setup#tracker)
Expand Down

0 comments on commit a1c7f41

Please sign in to comment.