Difference between revisions of "Template:Settings download clients download clients"

From Servarr
Line 1: Line 1:
−
* Usenet  
+
<noinclude>
 +
<templatedata>
 +
{
 +
"params": {
 +
"ARRNAME": {
 +
"description": "Name of the ARR",
 +
"example": "Radarr",
 +
"type": "string",
 +
"default": "Fake Radarr",
 +
"required": true
 +
}
 +
}
 +
}
 +
</templatedata>
 +
</noinclude>
 +
 
 +
 
 +
===== 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.
 
*# {{{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.
 
*#* Examples: movies, tv, series, music, ect.
Line 6: Line 23:
 
*# {{{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.
 
*# {{{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.
 
*# Leftover files from the download will be sent to your trash or recycling.
 
*# Leftover files from the download will be sent to your trash or recycling.
−
* BitTorrent - If you're downloading using a BitTorrent client, the process is slightly different:
+
 
 +
===== Usenet Client Settings=====
 +
PLACEHOLDER
 +
 
 +
===== 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. It monitors this 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 by default {{{ARRNAME}}} will copy the file, which uses twice the disk space.  
 
*# 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 by default {{{ARRNAME}}} will copy the file, which uses twice the disk space.  
 
*# An advanced option to hardlink can be enabled (Settings > Media Management > Importing) which will attempt to hardlink the media to your Series folder. A hardlink will allow not use any additional disk space. If the hardlink creation fails, {{{ARRNAME}}} will fall back to the default behavior and copy the file.
 
*# An advanced option to hardlink can be enabled (Settings > Media Management > Importing) which will attempt to hardlink the media to your Series folder. A hardlink will allow not use any additional disk space. If the hardlink creation fails, {{{ARRNAME}}} will fall back to the default behavior 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.
 
*# 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=====
 +
PLACEHOLDER
 +
 +
==== Supported Clients ====
 
** Sabnzbd  
 
** Sabnzbd  
 
*** Website: [http://sabnzbd.org/ SabNZBd]
 
*** Website: [http://sabnzbd.org/ SabNZBd]

Revision as of 15:08, 23 February 2021

No description.

Template parameters

ParameterDescriptionTypeStatus
ARRNAMEARRNAME

Name of the ARR

Default
Fake Radarr
Example
Radarr
Stringrequired


Usenet Process
    1. {{{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.
    2. {{{ARRNAME}}} will monitor your download clients active downloads that use that category name. It monitors this via your download client's API.
    3. 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}}}
    4. {{{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.
    5. Leftover files from the download will be sent to your trash or recycling.
Usenet Client Settings

PLACEHOLDER

Torrent Process
    1. {{{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.
    2. {{{ARRNAME}}} will monitor your download clients active downloads that use that category name. It monitors this via your download client's API.
    3. 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 by default {{{ARRNAME}}} will copy the file, which uses twice the disk space.
    4. An advanced option to hardlink can be enabled (Settings > Media Management > Importing) which will attempt to hardlink the media to your Series folder. A hardlink will allow not use any additional disk space. If the hardlink creation fails, {{{ARRNAME}}} will fall back to the default behavior and copy the file.
    5. 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

PLACEHOLDER

Supported Clients

    • Sabnzbd
    • Nzbget
    • NZBVortex
    • Pneumatic
      • Website: None at this time
      • Streaming Add-on for XBMC.
    • 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
    • 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
    • uTorrent
      • Version 3.0 or newer required. Requires Web UI (located in Preferences -> Advanced) enabled.
      • Website: uTorrent
    • 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
    • qBittorrent
      • Requires qBittorrent 3.2.4 or higher.
      • Website: qBittorrent
    • Vuze
      • Requires Vuze 5.0.0.0 or higher
      • Website: Vuze
    • DownloadStation
    • 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.

Retrieved from "https://wikiold.servarr.com/index.php?title=Template:Settings_download_clients_download_clients&oldid=3236"