diff --git a/docs/Downloaders/qBittorrent/Basic-Setup.md b/docs/Downloaders/qBittorrent/Basic-Setup.md index 7d3238766..971e3d019 100644 --- a/docs/Downloaders/qBittorrent/Basic-Setup.md +++ b/docs/Downloaders/qBittorrent/Basic-Setup.md @@ -4,4 +4,251 @@ ------ -## Soon +!!! Note + Settings that aren't covered means you can change them to your own liking or just leave them on default. + +------ + +## Downloads + +`Tools` => `Options` => `Downloads` (Or click on the cog wheel to access the options) + +### When adding a torrent + +![!When adding a torrent](images/qb-options-downloads-when-adding-a-torrent.png) + +1. For consistent with other torrents I recommend leaving this on `Original`. + + !!! check "" + **Suggested: `Original`** + +1. Delete the .torrent file after it has been added to qBittorrent. + + !!! check "" + **Suggested: `Personal preferences`** + +1. Pre-allocated disk space for the added torrents, this limits fragmentation and also makes sure if you use a cache drive or a feeder disk that the space is available. + + !!! check "" + **Suggested: `Enabled`** + +### Saving Management + +![Saving Management](images/qb-options-downloads-saving-management.png) + +1. Make sure this is set to `Automatic` else your downloads do not go into the category folder. + + !!! check "" + **Suggested: `Automatic`** + +1. This helps you to manage your file location based on Categories. + + !!! check "" + **Suggested: `Enabled`** + +1. Same as `Step 2` + + !!! check "" + **Suggested: `Enabled`** + +1. Your download root path (Download folder/location). + + !!! check "" + **Read the `ATTENTION` block below** + +1. If you enable this, your incomplete downloads will be placed first in this location before moved to your `Default Save Path:`. This could be useful if you want your downloads to use a separate SSD/Feeder disk[^1]. But this also results in extra unnecessary moves or in worse cases a slower and more I/O intensive copy + delete. + + !!! check "" + **Suggested: `Personal preferences`** + +#### ATTENTION + +--8<-- "includes/downloaders/warning-path-location.md" + +------ + +## Connection + +### Listening Port + +![!Listening Port](images/qbt-options-connection.png) + +1. Set this on TCP for the best performance + + !!! check "" + **Suggested: `TCP`** + +1. Your port used for incoming connection, this also the port you opened in your router/firewall or port forwarding on your VPN provider to make sure you're connectable. + + !!! check "" + **Suggested: `The port you opened in your router/firewall or port forwarding on your VPN provider`** + +1. This should be actually Disabled in your router for several security reasons. + + !!! check "" + **Suggested: `Disabled`** + +1. Make sure this is Disabled so you don't mess up the forwarded port. + + !!! check "" + **Suggested: `Disabled`** + +### Connections Limits + +![!Connections Limits](images/qbt-options-connection-connections-limits.png) + +The best settings for this depend on many factors so I won't be covering this. + +!!! check "" + **Suggested: `personal preferences based on your setup and connection.`** + +### Proxy Server + +![!Proxy Server](images/qbt-options-connection-proxy-server.png) + +This is where you would add for example your SOCKS5 settings from your VPN provider. + +!!! check "" + **Suggested: `I personally don't recommend this unsecure option being it's un-encrypted and only spoofs your IP.`** + +------ + +## Speed + +### Global Rate Limits + +![!Global Rate Limits](images/qbt-options-speed-global-rate-limits.png) + +Here you can set your global rate limits, meaning your maximum download/upload speed used by qBittorrent.(for all torrents) + +What's the best setting depends on many factors? + +- Your ISP speed. +- Your hardware used. +- Your personal usage of your connection for other things. + + !!! check "" + **Suggested: `For a home connection that you use with others it's best practice to set the upload/download rate to about 70-80% of your maximum upload/download speed.`** + +### Alternative Rate Limits + +![!Alternative Rate Limits](images/qbt-options-speed-alternative-rate-limits.png) + +When Enabled, basically the same as above but with the option to setup a schedule examples: + +- Limit your upload/download rate during daytime when you make most use of it, and unlimited it during nighttime when no one is using the connection. +- If you have an internet connectivity that's limited during specific hours (unlimited bandwidth during the night, but limited during the day) + + !!! check "" + **Suggested: `Personal preferences`** + +### Rate Limits Settings + +![!Rate Limits Settings](images/qbt-options-speed-rate-limits-settings.png) + +Not going to cover the the technical part what it does, But the following setting is recommended for best speeds (in most cases) + +1. Prevents you to be flooded if the uTP protocol is used for any reason. + + !!! check "" + **Suggested: `Enabled`** + +1. Apply rate limit to transport overhead + + !!! check "" + **Suggested: `Disabled`** + +1. Prevents you to be flooded if the uTP protocol is used for any reason. + + !!! check "" + **Suggested: `Enabled`** + +------ + +## Bittorrent + +### Privacy + +![!Privacy](images/qb-options-bittorrent-privacy.png) + +1. These settings are mainly used for public trackers (and should be enabled for them) and not for private trackers, decent private trackers use a private flag where they ignore these settings. + + !!! check "" + **Suggested: `Personal preferences`** + +1. Recommended setting `Allow encryption` rather than enforcing it allows more peers to connect and is recommended on underpowered systems as it will allow for lower overhead. + + !!! check "" + **Suggested: `Allow encryption`** + +1. Anonymous mode hides clients (qBittorrent) fingerprint from the peer-ID, sets the ‘User-Agent’ to Null and it doesn’t share your IP-address directly with trackers (though peers will still see your IP address). If using private trackers, it's recommended to `disable` this. I also got reports from people who are using this that they had worse speed. + + !!! check "" + **Suggested: `Disabled`** + +### Torrent Queueing + +![!Torrent Queueing](images/qb-options-bittorrent-torrent-queueing.png) + +These options allow you to control the number of torrents being downloaded and uploaded. + +!!! check "" + **Suggested: `personal preferences based on your setup and connection.`** + +### Seeding Limits + +![!Seeding Limits](images/qb-options-bittorrent-seeding-limits.png) + +1. Your seeding ratio preference (When both enable then this option is a or) + + !!! check "" + **Suggested: `Disabled`** + +1. Your seeding time preference (When both enabled then this option is a or) + + !!! check "" + **Suggested: `Disabled`** + +1. What to do when ratio or seeding time is reached. + + !!! check "" + **Suggested: `Paused and Disabled`** + +!!! tip + Personally, I recommend using the seeding goals in your Starr Apps indexer settings (enable advanced), or use [qBit Manage](/Downloaders/qBittorrent/3rd-party-tools/#qbit-manage){:target="_blank" rel="noopener noreferrer"} + +### Automatically add these trackers to new downloads + +![!Automatically add these trackers to new downloads](images/qb-options-bittorrent-automatically-add-these-trackers.png) + +!!! check "" + **Recommendation: `Disabled`** + +!!! WARNING + :bangbang: **NEVER USE THIS OPTION ON (Semi-)PRIVATE TRACKERS** :bangbang: + +------ + +## Web UI + +### Authentication + +![!Authentication](images/qb-options-webui-authentication.png) + +1. When enabled there will be no authentication request for clients on localhost. +1. When enabled bypass authentication for clients in the `step.3` whitelist. +1. Add here all IP subnets that you want to have the option to bypass the authentication. + +### Security + +![!Security](images/qb-options-webui-security.png) + +1. Enable clickjacking protection, in some cases when this is enabled it could result in issues. + + !!! check "" + **Suggested: `Disabled`** + +--8<-- "includes/support.md" + +[^1]: + If you use unRaid then you don't need this being, you can make use of the default cache drive option. diff --git a/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-automatically-add-these-trackers.png b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-automatically-add-these-trackers.png new file mode 100644 index 000000000..eafa9e9a0 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-automatically-add-these-trackers.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-privacy.png b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-privacy.png new file mode 100644 index 000000000..cd0e13c4d Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-privacy.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-seeding-limits.png b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-seeding-limits.png new file mode 100644 index 000000000..b1e567578 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-seeding-limits.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-torrent-queueing.png b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-torrent-queueing.png new file mode 100644 index 000000000..1ba379e76 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-bittorrent-torrent-queueing.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-downloads-saving-management.png b/docs/Downloaders/qBittorrent/images/qb-options-downloads-saving-management.png new file mode 100644 index 000000000..c7044b35f Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-downloads-saving-management.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-downloads-when-adding-a-torrent.png b/docs/Downloaders/qBittorrent/images/qb-options-downloads-when-adding-a-torrent.png new file mode 100644 index 000000000..3bf266289 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-downloads-when-adding-a-torrent.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-webui-authentication.png b/docs/Downloaders/qBittorrent/images/qb-options-webui-authentication.png new file mode 100644 index 000000000..c8dd87aef Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-webui-authentication.png differ diff --git a/docs/Downloaders/qBittorrent/images/qb-options-webui-security.png b/docs/Downloaders/qBittorrent/images/qb-options-webui-security.png new file mode 100644 index 000000000..b631b499e Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qb-options-webui-security.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-connection-connections-limits.png b/docs/Downloaders/qBittorrent/images/qbt-options-connection-connections-limits.png new file mode 100644 index 000000000..8fa81e188 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-connection-connections-limits.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-connection-proxy-server.png b/docs/Downloaders/qBittorrent/images/qbt-options-connection-proxy-server.png new file mode 100644 index 000000000..857dcd70f Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-connection-proxy-server.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-connection.png b/docs/Downloaders/qBittorrent/images/qbt-options-connection.png new file mode 100644 index 000000000..cc7dc33e8 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-connection.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-speed-alternative-rate-limits.png b/docs/Downloaders/qBittorrent/images/qbt-options-speed-alternative-rate-limits.png new file mode 100644 index 000000000..d7348733a Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-speed-alternative-rate-limits.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-speed-global-rate-limits.png b/docs/Downloaders/qBittorrent/images/qbt-options-speed-global-rate-limits.png new file mode 100644 index 000000000..74f8a3b21 Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-speed-global-rate-limits.png differ diff --git a/docs/Downloaders/qBittorrent/images/qbt-options-speed-rate-limits-settings.png b/docs/Downloaders/qBittorrent/images/qbt-options-speed-rate-limits-settings.png new file mode 100644 index 000000000..2d859b5be Binary files /dev/null and b/docs/Downloaders/qBittorrent/images/qbt-options-speed-rate-limits-settings.png differ diff --git a/includes/downloaders/basic-setup.md b/includes/downloaders/basic-setup.md index 292439133..6a66d7e86 100644 --- a/includes/downloaders/basic-setup.md +++ b/includes/downloaders/basic-setup.md @@ -10,6 +10,6 @@ This basic example is based on the use of docker images But you're able to change this, by not using the pre-defined/recommended paths like: - - `/downloads` => `/data/downloads` + - `/downloads` => `/data/downloads`, `/data/usenet`, `/data/torrents` - `/movies` => `/data/media/movies` - - `/tv` => `/data/media/tv`. + - `/tv` => `/data/media/tv`