StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-11-01 00:56:03 +08:00
Code Issues Projects Releases Packages Wiki Activity

Action Bot is pushing

bobokun 2024-02-28 21:07:49 +00:00
parent 173d03fe2d
commit be57b235e4
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
Config-Setup.md

@ -32,9 +32,9 @@ This section defines your qBittorrent instance.
| Variable | Definition | Required |
| :------- | :---------------------------------- | :----------------- |
| `host` | Hostname for qBittorrent Web API, `[http[s]://]localhost[:8080][/path]` e.g. `192.168.2.253:8080` or `https://mydomain.tld/qbittorrent` | <center>✅</center> |
| `user` | The username for your Qbittorrent's webui. Leave blank if no authentication is configured for qbm's host ip to access the webui. | <center>❌</center> |
| `pass` | The password for your Qbittorrent's webui. Leave blank if no authentication is configured for qbm's host ip to access the webui. | <center>❌</center> |
| `host` | IP address of your qB installation. | <center>✅</center> |
| `user` | The user name of your qB's webUI. | <center>❌</center> |
| `pass` | Thee password of your qB's webUI. | <center>❌</center> |
<br>
@ -49,8 +49,14 @@ This section defines any settings defined in the configuration.
| `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> |
| `nohardlinks_tag` | Define the tag of any torrents that don't have hardlinks (Used in `--tag-nohardlinks`) | <center>❌</center> |
| `share_limits_tag` | Will add this tag when applying share limits to provide an easy way to filter torrents by share limit group/priority for each torrent. For example, if you have a share-limit group `cross-seed` with a priority of 2 and the default share_limits_tag `~share_limits` would add the tag `~share_limit_2.cross-seed` (Used in `--share-limits`) | <center>❌</center> |
| `share_limits_min_seeding_time_tag` | Will add this tag when applying share limits to torrents that have not yet reached the minimum seeding time (Used in `--share-limits`) | <center>❌</center> |
| `share_limits_min_num_seeds_tag` | Will add this tag when applying share limits to torrents that have not yet reached the minimum number of seeds (Used in `--share-limits`) | <center>❌</center> |
| `share_limits_last_active_tag` | Will add this tag when applying share limits to torrents that have not yet reached the last active limit (Used in `--share-limits`) | <center>❌</center> |
| `ignoreTags_OnUpdate` | When running `--tag-update` function, it will update torrent tags for a given torrent even if the torrent has one or more of the tags defined here. | <center>❌</center> |
| `cross_seed_tag` | When running `--cross-seed` function, it will update any added cross-seed torrents with this tag. | <center>❌</center> |
| `cat_filter_completed` | When running `--cat-update` function, it will filter for completed torrents only. | <center>❌</center> |
| `share_limits_filter_completed` | When running `--share-limits` function, it will filter for completed torrents only. | <center>❌</center> |
| `tag_nohardlinks_filter_completed` | When running `--tag-nohardlinks` function, , it will filter for completed torrents only. | <center>❌</center> |
## **directory:**
---
@ -151,15 +157,15 @@ Control how torrent share limits are set depending on the priority of your group
| `exclude_all_tags` | Filter the group based on one or more tags. Multiple exclude_all_tags are checked with an **AND** condition. All tags defined here must be present in the torrent for it to be excluded in this group | None | list | <center>❌</center> |
| `exclude_any_tags` | Filter the group based on one or more tags. Multiple exclude_any_tags are checked with an **OR** condition. Any tags defined here must be present in the torrent for it to be excluded in this group | None | list | <center>❌</center> |
| `categories` | Filter by including one or more categories. Multiple categories are checked with an **OR** condition. Since one torrent can only be associated with a single category, multiple categories are checked with an **OR** condition | None | list | <center>❌</center> |
| `cleanup` | **WARNING!!** Setting this as true will remove any torrents that satisfies the share limits (max ratio OR max time). It will also delete the torrent's data if and only if no other torrents are using the same folder/files. | False | bool | <center>❌</center> |
| `max_ratio` | Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading. (`-2` : Global Limit , `-1` : No Limit) | -1 | float | <center>❌</center> |
| `max_seeding_time` | Will set the torrent Maximum seeding time (minutes) until torrent is stopped from seeding. (`-2` : Global Limit , `-1` : No Limit) | -1 | int | <center>❌</center> |
| `cleanup` | **WARNING!!** Setting this as true will remove and delete contents of any torrents that satisfies the share limits **(max time OR max ratio)** It will also delete the torrent's data if and only if no other torrents are using the same folder/files. | False | bool | <center>❌</center> |
| `max_ratio` | Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading and may be cleaned up / removed if the minimums have been met. (`-2` : Global Limit , `-1` : No Limit) | -1 | float | <center>❌</center> |
| `max_seeding_time` | Will set the torrent Maximum seeding time (minutes) until torrent is stopped from seeding/uploading and may be cleaned up / removed if the minimums have been met. (`-2` : Global Limit , `-1` : No Limit) | -1 | int | <center>❌</center> |
| `min_seeding_time` | Will prevent torrent deletion by cleanup variable if torrent has not yet met minimum seeding time (minutes). If the torrent has not yet reached this minimum seeding time, it will change the share limits back to no limits and resume the torrent to continue seeding. | 0 | int | <center>❌</center> |
| `last_active` |Will prevent torrent deletion by cleanup variable if torrent has been active within the last x minutes. If the torrent has been active within the last x minutes, it will change the share limits back to no limits and resume the torrent to continue seeding. | 0 | int | <center>❌</center> |
| `limit_upload_speed` | Will limit the upload speed KiB/s (KiloBytes/second) (`-1` : No Limit) | -1 | int | <center>❌</center> |
| `resume_torrent_after_change` | Will resume your torrent after changing share limits. | True | bool | <center>❌</center> |
| `add_group_to_tag` | This adds your grouping as a tag with a prefix defined in settings (share_limits_tag). Example: A grouping named noHL with a priority of 1 will have a tag set to `~share_limit_1.noHL` (if using the default prefix). | True | bool | <center>❌</center> |
| `min_num_seeds` | This will prevent torrent deletion by cleanup variable if the number of seeds is less than the value set here (depending on the tracker, you may or may not be included). If the torrent has less number of seeds than the min_num_seeds, the share limits will be changed back to no limits and resume the torrent to continue seeding. | 0 | int | <center>❌</center> |
| `min_num_seeds` | Will prevent torrent deletion by cleanup variable if the number of seeds is less than the value set here (depending on the tracker, you may or may not be included). If the torrent has less number of seeds than the min_num_seeds, the share limits will be changed back to no limits and resume the torrent to continue seeding. | 0 | int | <center>❌</center> |
## **recyclebin:**
---