Template:Settings download clients download clients
From Servarr
(Redirected from Template:Settings Download Clients Download Clients)
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| ARRNAME | ARRNAME | Name of the ARR
| String | required |
Usenet Process
- {{{ARRNAME}}} will send a download request to your client, and associate it with a label or category name that you have configured in the download client settings. Examples: movies, tv, series, music, ect.
- {{{ARRNAME}}} will monitor your download clients active downloads that use that category name. It monitors this via your download client's API.
- When the download is completed, {{{ARRNAME}}} will know the final file location as reported by your download client. This file location can be almost anywhere, as long as it is somewhere separate from your media folder and accessible by {{{ARRNAME}}}
- {{{ARRNAME}}} will scan that completed file location for files that {{{ARRNAME}}} can use. It will parse the file name to match it against the requested media. If it can do that, it will rename the file according to your specifications, and move it to the specified media location.
- Atomic Moves (instant moves) are enabled by default. The file system and mounts must be the same for your completed download directory and your media library. If the the atomic move fails or your setup does not support hardlinks and atomic moves then {{{ARRNAME}}} will fall back and copy the file then delete from the source which is IO intensive.
Usenet Client Settings
- Name - The name of the download client within {{{ARRNAME}}}
- Enable - Enable this Download Client
- Host - The URL of your download client
- Port - The port of your download client
- Use SSL - Use a secure connection with your download client. [[{{{ARRNAME}}}_FAQ#invalid_certificate_and_other_https_or_ssl_issues|Please be aware of this common mistake.]]
- URL Base - Add a prefix to the url; this is commonly needed for reverse proxies.
- API Key - the API key to authenticate to your client
- Username - the username to authenticate to your client (typically not needed)
- Password- the password to authenticate to your client (typically not needed)
- Category - the category within your download client that {{{ARRNAME}}} will use
- Recent Priority - download client priority for recently released media
- Older Priority - download client priority for media released not recently
- Client Priority - Priority of the download Client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority.
Torrent Process
- {{{ARRNAME}}} will send a download request to your client, and associate it with a label or category name that you have configured in the download client settings. Examples: movies, tv, series, music, ect.
- {{{ARRNAME}}} will monitor your download clients active downloads that use that category name. This monitoring occurs via your download client's API.
- Completed files are left in their original location to allow you to seed the file (ratio or time can be adjusted in the download client or from within {{{ARRNAME}}} under the specific download client). When files are imported to your media folder {{{ARRNAME}}} will hardlink the file if supported by your setup or copy if not hardlinks are not supported.
- Hardlinks are enabled by default. A hardlink will allow not use any additional disk space. The file system and mounts must be the same for your completed download directory and your media library. If the hardlink creation fails or your setup does not support hardlinks then {{{ARRNAME}}} will fall back and copy the file.
- If the "Completed Download Handling - Remove" option is enabled in {{{ARRNAME}}}'s settings, {{{ARRNAME}}} will delete the original file and torrent from your client, but only if the client reports that seeding is complete and torrent is stopped.
Torrent Client Settings
- Name - The name of the download client within {{{ARRNAME}}}
- Enable - Enable this Download Client
- Host - The URL of your download client
- Port - The port of your download client
- Use SSL - Use a secure connection with your download client. [[{{{ARRNAME}}}_FAQ#invalid_certificate_and_other_https_or_ssl_issues|Please be aware of this common mistake.]]
- URL Base - Add a prefix to the url; this is commonly needed for reverse proxies.
- Username - the username to authenticate to your client
- Password- the password to authenticate to your client
- Category - the category within your download client that {{{ARRNAME}}} will use
- Post-Import Category - the category to set after the release is downloaded and imported. Please note that this breaks completed download handling removal.
- Recent Priority - download client priority for recently released media
- Older Priority - download client priority for media released not recently
- Initial State - Initial state for torrents
- Client Priority - Priority of the download Client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority.
Supported Clients
- Sabnzbd
- Website: SabNZBd
- Nzbget
- Website: NZBget
- NZBVortex
- Website: NZBVortex
- Pneumatic
- Website: None at this time
- Streaming Add-on for XBMC.
- DownloadStation
- Website: DownloadStation
- UsenetBlackhole
- Puts NZB into a folder to be picked up by an external tool. Will watch another folder to check for completed downloads.
- Deluge
- Website: Deluge
- TorrentBlackhole
- Puts .torrent files into a folder, to be picked up by an external tool. Will watch another folder to check for completed downloads.
- Transmission
- Website: Transmission
- uTorrent
- Version 3.0 or newer required. Requires Web UI (located in
Preferences -> Advanced) enabled. - Website: uTorrent
- Version 3.0 or newer required. Requires Web UI (located in
- rTorrent
- Requires rTorrent version 0.9.0 or newer compiled with XML-RPC support, and a SCGI to HTTP proxy (usually Lighttpd, Nginx, or Apache; ruTorrent can also provide this on on the URL
plugins/rpc/rpc.php). Look for ruTorrent instructions for how to set up rTorrent. - Website: rTorrent
- Requires rTorrent version 0.9.0 or newer compiled with XML-RPC support, and a SCGI to HTTP proxy (usually Lighttpd, Nginx, or Apache; ruTorrent can also provide this on on the URL
- qBittorrent
- Requires qBittorrent 3.2.4 or higher.
- Website: qBittorrent
- Vuze
- Requires Vuze 5.0.0.0 or higher
- Website: Vuze
- DownloadStation
- Website: DownloadStation
- Hadouken
- Website: Hadouken
Compatibility
- {{{ARRNAME}}} is only able to set the seed ratio/time on clients that support setting this value via their API when the torrent is added. See the table below for client compatibility.
| Client | Ratio | Time |
|---|---|---|
| Deluge | Yes | - |
| Hadouken | - | - |
| qBittorrent | Yes | Yes |
| rTorrent | - | - |
| Torrent Blackhole | - | - |
| Download Station | - | - |
| Transmission | Yes | Idle Limit [1] |
| uTorrent | Yes | Yes |
| Vuze | Yes | Yes |
[1] Transmission internally has an Idle Time check, but {{{ARRNAME}}} compares it with the seeding time if the idle limit is set on a per-torrent basis. This is done as workaround to Transmission’s api limitations.
