fujin/rtorrent
1
0
Fork 0
mirror of https://github.com/rakshasa/rtorrent.git synced 2026-10-08 15:19:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding initial content

chros73
2016-07-25 14:56:27 +01:00
parent 5aab015490
commit 63f06f53c8
1 changed files with 118 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Favoring-group-of-torrents.md
+118
@@ -0,0 +1,118 @@
# Favoring one group of torrents over the rest of them
This is one of the most frequently asked questions regarding to the usage of `rTorrent`. It turned out that its realization is pretty simple: let's adjust upload rate dynamically and other attributes of them.
**Contents**
* [Scenario](#scenario)
* [Realization](#realization)
* [Theory](#theory)
* [Sample config](#sample-config)
* [Helper script](#helper-script)
## Scenario
There are sites where seeding data back is pretty hard while it's easy for others. So we want to distinguish between 2 groups, a special group and the rest of them:
- special group: we want to favor this group in any possible way
- the rest: it's not so important to provide the best circumstances for them, but we still want to seed them as long as we can
Applying this to downloading is easy (all we have to set is `d.priority` accordingly and it will take care about everything) but not to seeding.
## Realization
### Theory
- define 1 `throttle.up` group named `slowup` and set an inital value for it that will contain all the unimportant torrents (torrents that are assigned to this group)
- torrents that don't belong to the `slowup` throttle belong to the special group
- set `d.priority` to high for the special group that will take care of the downloading part
- raise the default `min_peers`, `max_peers` and `max_uploads` values for the special group (note: these settings aren't saved along the session hence we have to modify them on the fly, if necessary)
- setup 2 watch directories to automate this assignment between torrents and groups
- adjust the upload rate of `slowup` throttle on the fly (with the help of an external script) depending on the current upload rate of the special group and the current global upload rate
### Sample config
Let's see the related settings at once first. These settings are used with 74/20 Mbps connection and with `rTorrent v0.9.6`.
```ini
# Global upload and download rate in KiB, `0` for unlimited (`download_rate`, `upload_rate`)
throttle.global_down.max_rate.set_kb = 8700
throttle.global_up.max_rate.set_kb = 2200
# Maximum number of simultaneous downloads and uploads slots (global slots!) (`max_downloads_global`, `max_uploads_global`)
throttle.max_downloads.global.set = 300
throttle.max_uploads.global.set = 300
# Maximum and minimum number of peers to connect to per torrent while downloading (`min_peers`, `max_peers`) Default: `100` and `200` respectively
throttle.min_peers.normal.set = 99
throttle.max_peers.normal.set = 100
# Same as above but for seeding completed torrents (seeds per torrent), `-1` for same as downloading (`min_peers_seed`, `max_peers_seed`) Default: `-1` for both
throttle.min_peers.seed.set = -1
throttle.max_peers.seed.set = -1
# Maximum number of simultaneous downloads and uploads slots per torrent (`max_uploads`) Default: `50` for both
throttle.max_downloads.set = 50
throttle.max_uploads.set = 50
# Throttles rates for (groups of) downloads or IP ranges. (throttle_up) These throttles borrow bandwidth from
# the global throttle and thus are limited by it too.
# You can assign throttles to a stopped (!) download with Ctrl-T. The `NULL` throttle is a special unlimited
# throttle that bypasses the global throttle.
# Limits the upload rate to 600 kb/s for the `slowup` throttle group. We also use this property to distinguish
# `special` and `rest` group. This value will be auto-adjusted by a helper script in Favoring section.
throttle.up = slowup,600
# initial `slowup` group values for the previous similar 3 settings that will be overridden by per torrent settings
# Favouring section. `cfg.slowup.d.peers_min` ~ `throttle.min_peers.normal` ,
# `cfg.slowup.d.peers_max` ~ `throttle.max_peers.normal` , `cfg.slowup.d.uploads_max` ~ `throttle.max_uploads`
method.insert = cfg.slowup.d.peers_min, value|private, 29
method.insert = cfg.slowup.d.peers_max, value|private, 50
method.insert = cfg.slowup.d.uploads_max, value|private, 15
# Watch directories for new torrents (meta files). Also specifying whether they belong to special group by setting:
# - high priority for the special group
# - `slowup` throttle for `rest` group
schedule2 = special_watch_dir, 5, 10, "load.start=\"./watch/start_special/*.torrent\", d.priority.set=3"
schedule2 = rest_watch_dir, 6, 10, "load.start=\"./watch/start_rest/*.torrent\", d.throttle_name.set=slowup"
# Set `pyro.bin_dir` to users `bin` directory. Make sure you end it with a "/".
# If this is left empty, then the shell's path is searched.
method.insert = pyro.bin_dir, string|const|private, (cat,"~/bin/")
##### begin: Favoring special group of torrents over the rest #####
# helper method: Modifies the `peers_min`, `peers_max`, `max_uploads` values of a torrent for
# both downloading and uploading
method.insert = d.modify_slots, simple|private, "d.peers_min.set=(argument.0); d.peers_max.set=(argument.1); d.uploads_max.set=(argument.2)"
# Modifies the above properties for a torrent based on which group it belongs to
method.insert = d.modify_slots_both, simple, "branch=((not,(d.throttle_name))),((d.modify_slots,(throttle.min_peers.normal),(throttle.max_peers.normal),(throttle.max_uploads))),((d.modify_slots,(cfg.slowup.d.peers_min),(cfg.slowup.d.peers_max),(cfg.slowup.d.uploads_max)))"
# Modify both group values when a torrent is resumed (even after hash-checking or after `rTorrent` is restarted)
method.set_key = event.download.resumed, modify_slots_resumed_both, "d.modify_slots_both="
# helper method: gets one of the below info with the help of `getLimits.sh` script
# note: variables are inside the script, you have to edit those values there!
method.insert = get_limit, simple|private, "execute.capture=\"$cat=$pyro.bin_dir=,getLimits.sh\",$argument.0=,$argument.1=,$argument.2=,$argument.3="
# Dynamically adjusts the 2nd group (`slowup` throttle) uprate (upload speed) to always leave enough bandwidth
# to the 1st main group. (More info in `getLimits.sh` script)
schedule2 = adjust_throttle_slowup, 14, 20, "throttle.up=slowup,\"$get_limit=$cat=up,$convert.kb=$throttle.global_up.rate=,$convert.kb=$throttle.up.rate=slowup\""
# Dynamically adjusts the global download rate to always leave enough bandwidth to the 1st main group upload rate.
# It's good for async connection (e.g. ADSL) where upload speed can be slowed down if download speed is
# close to max. Comment it out if you don't need it.
schedule2 = adjust_throttle_global_down_max_rate, 54, 60, "throttle.global_down.max_rate.set_kb=\"$get_limit=$cat=down,$convert.kb=$throttle.global_up.rate=,$convert.kb=$throttle.up.rate=slowup\""
# Helper method to display the current rate information: `^x` + `i=`.
# It displays: MainUpRate: 1440 , ThrottleUpRate: 92 , ThrottleLimit: 100
method.insert = i, simple, "print=\"$get_limit=$cat=info,$convert.kb=$throttle.global_up.rate=,$convert.kb=$throttle.up.rate=slowup,$convert.kb=$throttle.up.max=slowup\""
##### end: Favoring special group of torrents over the rest #####
```
### Helper script
We need an [`getLimits.sh`](https://github.com/chros73/rtorrent-ps_setup/blob/master/ubuntu-14.04/home/chros73/bin/getLimits.sh) external script that should be placed under `~/bin` directory, since we can't do basic math in `rTorrent` config files.