squidy/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2026-01-02 21:52:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated Explanation of Options in qBittorrent (mediawiki)

joopbraak
2021-09-28 16:03:05 +02:00
parent 062ed55613
commit 42df8b1393
1 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Explanation-of-Options-in-qBittorrent.mediawiki

@@ -120,6 +120,8 @@ The following settings are also documented in qBittorrent and libtorrent, respec
* '''Confirm removal of all tags''' — displays a user confirmation message before removing all tags.
* '''Download tracker's favicon''' — when enabled, qBittorrent tries to fetch the "favicon.ico" file from each tracker URL. This icon is displayed in the left pane under "Trackers" in GUI.
* '''Save path history length''' — this controls how many recent paths qBittorrent will remember.
* '''Enable embedded tracker''' — (default: disabled) Enable qbittorrent's tracker functionality. It is not a fully-featured bittorrent tracker, but it supports the basic features need for sharing a few torrents see the [https://github.com/qbittorrent/qBittorrent/wiki/How-to-use-qBittorrent-as-a-tracker how-to wiki page] for more info.
* '''Embedded tracker port''' — (default: 9000) The port the embedded tracker should listen on.
=== libtorrent–specific configuration ===
A complete list of libtorrent configuration may be found [https://www.libtorrent.org/reference-Settings.html here].
@@ -139,18 +141,21 @@ A complete list of libtorrent configuration may be found [https://www.libtorrent
* '''Outgoing ports [0:Disabled]''' — (default: 0) This is the range of ports to use for binding outgoing connections to and it shouldn't be too small. It is useful for users that have routers that allow QoS settings based on local port. Setting outgoing ports will limit the ability to keep multiple connections to the same client, even for different torrents. It is not recommended to change this setting. Its main purpose is to use it as an escape hatch for cheap routers with QoS capability but can only classify flows based on port numbers. It is a range instead of a single port because of the problems with failing to reconnect to peers if a previous socket to that peer and port is in the waiting state.
* '''UPnP lease duration [0:Permanent lease]''' — (default: 0 s) The expiration time of UPnP port-mappings, specified in seconds. Some routers do not support expiration times on port-maps (nor correctly returning an error indicating lack of support). In those cases, set this to 0. Otherwise, don't set it any lower than 5 minutes.
* '''Type of service (ToS) for connections to peers''' — (default: 32) Determines the TOS byte set in the IP header of every packet sent to peers (including web seeds). 0x0 means no marking, 0x20 represents the QBone scavenger service.
* '''µTP-TCP mixed mode algorithm''' — determines how to treat TCP connections when there are uTP connections. Since uTP is designed to yield to TCP, there's an inherent problem when using swarms that have both TCP and uTP connections. If nothing is done, uTP connections would often be starved out for bandwidth by the TCP connections. This mode is called "Prefer TCP" in qBittorrent. The "Peer proportional" mode on the other hand, simply looks at the current throughput and rate limits all TCP connections to their proportional share based on how many of the connections are TCP. This works best if uTP connections are not rate limited by the global rate limiter.
* '''Allow multiple connections from the same IP address''' — determines if connections from the same IP address as existing onnections should be rejected or not. This option is disabled by default to prevent abusive behavior by peers. It may be useful to allow such connections in cases where simulations are run on the same machine, and all peers in a swarm has the same IP address.
* '''Enable embedded tracker''' — enable qbittorrent's tracker functionality. It is not a fully-featured bittorrent tracker, but it supports the basic features need for sharing a few torrents see the [https://github.com/qbittorrent/qBittorrent/wiki/How-to-use-qBittorrent-as-a-tracker how-to wiki page] for more info.
* '''Embedded tracker port''' — the port the embedded tracker should listen on.
* '''Upload slots behavior''' — it specifies which algorithm to use to determine which peers to unchoke:
** '''Fixed slots''' — the traditional choker with a fixed number of unchoke slots.
** '''Upload rate based''' — opens up unchoke slots based on the upload rate achieved to peers. The more slots that are opened, the marginal upload rate required to open up another slot increases.
* '''Upload choking algorithm''' — it controls the seeding unchoke behavior:
** '''Round-robin''' — rotates the peers that are unchoked when seeding. This distributes the upload bandwidth uniformly and fairly. It minimizes the ability for a peer to download everything without redistributing it.
** '''Fastest upload''' — unchokes the peers we can send to the fastest. This might be a bit more reliable in utilizing all available capacity.
** '''Anti-leech''' — prioritizes peers who have just started or are just about to finish the download. The intention is to force peers in the middle of the download to trade with each other.
* '''Strict super seeding''' — activate libtorrent's strict mode for super seeding ("when this is set to true, a piece has to have been forwarded to a third peer before another one is handed out. This is the traditional definition of super seeding.").
* '''µTP-TCP mixed mode algorithm''' — (default: Prefer TCP) Determines how to treat TCP connections when there are uTP connections. Since uTP is designed to yield to TCP, there's an inherent problem when using swarms that have both TCP and uTP connections. If nothing is done, uTP connections would often be starved out for bandwidth by the TCP connections. This mode is called "Prefer TCP" in qBittorrent. The "Peer proportional" mode on the other hand, simply looks at the current throughput and rate limits all TCP connections to their proportional share based on how many of the connections are TCP. This works best if uTP connections are not rate limited by the global rate limiter.
* '''Support internationalized domain name (IDN)''' — (default: disabled) When disabled, any tracker or web seed with an IDNA hostname (internationalized domain name) is ignored. This is a security precaution to avoid various unicode encoding attacks that might happen at the application level.
* '''Allow multiple connections from the same IP address''' — (default: disabled) Determines if connections from the same IP address as existing connections should be rejected or not. This option is disabled by default to prevent abusive behavior by peers. It may be useful to allow such connections in cases where simulations are run on the same machine, and all peers in a swarm have the same IP address.
* '''Validate HTTPS tracker certificates''' — (default: enabled) When set to true, the certificate of HTTPS trackers and HTTPS web seeds will be validated against the system's certificate store (as defined by OpenSSL). If the system does not have a certificate store, this option may have to be disabled in order to get trackers and web seeds to work).
* '''Server-side request forgery (SSRF) mitigation''' — (default: enabled) When enabled, tracker and web seed requests are subject to certain restrictions.
An HTTP(s) tracker requests to localhost (loopback) must have the request path start with "/announce". This is the conventional bittorrent tracker request. Any other HTTP(S) tracker request to loopback will be rejected. This applies to trackers that redirect to loopback as well.
Web seeds that end up on the client's local network (i.e. in a private IP address range) may not include query string arguments. This applies to web seeds redirecting to the local network as well. Web seeds on global IPs (i.e. not local network) may not redirect to a local network address.
* '''Disallow connection to peers on privileged ports''' — (default: disabled) When this is true, libtorrent will not attempt to make outgoing connections to peers whose port is < 1024. This is a safety precaution to avoid being part of a DDoS attack.
* '''Upload slots behavior''' — (default: Fixed slots) It specifies which algorithm to use to determine which peers to unchoke:
** '''Fixed slots''' — The traditional choker with a fixed number of unchoke slots.
** '''Upload rate based''' — Opens up unchoke slots based on the upload rate achieved to peers. The more slots that are opened, the marginal upload rate required to open up another slot increases.
* '''Upload choking algorithm''' — (default: Fastest upload) It controls the seeding unchoke behavior:
** '''Round-robin''' — Rotates the peers that are unchoked when seeding. This distributes the upload bandwidth uniformly and fairly. It minimizes the ability for a peer to download everything without redistributing it.
** '''Fastest upload''' — Unchokes the peers we can send to the fastest. This might be a bit more reliable in utilizing all available capacity.
** '''Anti-leech''' — Prioritizes peers who have just started or are just about to finish the download. The intention is to force peers in the middle of the download to trade with each other.
* '''Always announce to all trackers in a tier''' — controls how multi tracker torrents are treated. If this is set to true, all trackers in the same tier are announced to in parallel. Otherwise the behavior is as defined by the multi tracker specification.
* '''IP Address to report to trackers''' — is the ip address passed along to trackers. If this value is blank, the parameter will be omitted.
@@ -161,4 +166,5 @@ Deprecated options may be safely removed from your config file.
* '''Listen on IPv6 address''' — Also known as the config string <code>Connection\InterfaceListenIPv6</code> (since <code>4.2.1</code>). Replacement: "Optional IP address to bind to", confg string <code>Connection\InterfaceAddress</code>. Reason: [https://github.com/qbittorrent/qBittorrent/pull/11592 #11592].
* '''Maximum number of half-open connections''' — Also known as the config string <code>BitTorrent/Session/MaxHalfOpenConnections</code> (since <code>4.2.0</code>). Replacement: None. Reason: [https://github.com/arvidn/libtorrent/commit/ceccc2a4835fefce836001a7ccff8cca82d58999 option removed from libtorrent as it did not make sense anymore].
* '''Guided read cache''' — enables the disk cache to adjust the size of a cache line generated by peers to depend on the upload rate you are sending to that peer. The intention is to optimize the RAM usage of the cache, to read ahead further for peers that you're sending faster to.
* '''Guided read cache''' — enables the disk cache to adjust the size of a cache line generated by peers to depend on the upload rate you are sending to that peer. The intention is to optimize the RAM usage of the cache, to read ahead further for peers that you're sending faster to.
* '''Strict super seeding''' — activate libtorrent's strict mode for super seeding ("when this is set to true, a piece has to have been forwarded to a third peer before another one is handed out. This is the traditional definition of super seeding.").