Downloaders howto

Most commonly asked questions will have thire awnsers here, please search before asking!
mano3m
Recognized Developer
Posts: 225
Joined: 22 Aug 2012 21:37
Been thanked: 29 times
Contact:
Status: Offline

Downloaders howto

Postby mano3m » 23 Oct 2013 21:26

Over the recent few months we significantly improved the way CPS integrates with all sorts of downloaders both torrent and nzb. This howto will explain the features and how to set everything up.

It will be a work in progress for the time being. Any additions are very welcome.

Workflow
CPS works through several statuses during its processing which are visible in the Home and Wanted sections and marked with their appropriate colors (see this topic):
Available, Snatched, Failed, Missing, Ignored, Seeding, Downloaded, Done

CPS keeps track of the different statuses in the following way: When one or more releases have the snatched status, CPS starts asking the downloader once every minute Renamer Settings - Run Every, for its status. This will, for example, be "busy" while it is downloading. In the CPS logs the ETA sent by the downloader is show.

Available
This document starts when CPS determined which release it wants to download. This is a release with the available status. This can be either a torrent magnet, a torrent or an nzb. CPS will send this release to all compatible downloaders, so do not activate more than one downloader compatible with each protocol.

Snatched
The release is then sent through to the downloader through an available api. CPS downloads the torrent or nzb and sends this directly to the downloader without storing it. In the settings of each downloader the IP address and the port can be set. After the release has been sent CPS stores the ID of the release for tracking. The status of the release in CPS is now changed from available to snatched and a notification pops in in the web interface.

Failed
It could be that during the downloading stage the release download fails. For nzbs this can be because many articles are missing, for torrents it can be that the download stalled. The release status is then updated to failed. CPS will request the downloader to remove the failed release -setting- and already downloader files -setting-. Into then will start over and sdd the next best release -setting in renamer-.

Seeding (torrents only)
When a torrent release is finished downloading it can start seeding. CPS recognises this and its status is set to seeding. CPS will ask the downloader where the files that are being seeded are. If the renamer is set to either link or copy, CPS will now link or copy the downloaded files to the 'to' folder -setting- or its category folder, and leave the downloaded files alone for seeding. If the reneamer is set to move it will wait until seeding is finished before moving the files. How long a torrent needs to seed is sent to the downloaders by CPS when the torrent is added. This can be set for each torrent provider differently -settings-.

Downloaded
When the seeding status has ended, the downloader will tell CPS the movie had finished. Note NZBs finish without having seeded. The status is now updated to downloaded. If CPS has already copied or linked the movie to its final destination, CPS will now ask the downloader to remove the torrent -settng- and the files left behind -settjng-. If not, it will move the files to the 'to' folder or the folder set by its catagory. This will always happen for nzbs and only for torrents if movie is set -setting-.

Done
After a downloaded release has been renamed, CPS scans the final folder and adds all files to the database. The movie file that is scanned gets the done status.

Missing
When during any stage of the process after snatched the release cannot be found in all selected downloaders, the status is updated to missing. As soon as the release is found again, its is again updated to the appropriate status. If the release has been missing for a week, the status is updated to ignored and CPS will ignore the release from then on.

To do
- links to settings
- labels and folders
- table with what downloaders support which functions
- black hole
Last edited by mano3m on 18 Nov 2013 00:25, edited 4 times in total.

mano3m
Recognized Developer
Posts: 225
Joined: 22 Aug 2012 21:37
Been thanked: 29 times
Contact:
Status: Offline

Renamer Settings

Postby mano3m » 17 Nov 2013 23:57

Renamer Settings.png
Renamer Settings
Renamer Settings.png (83.93 KiB) Viewed 12366 times
Last edited by mano3m on 18 Nov 2013 00:21, edited 2 times in total.

mano3m
Recognized Developer
Posts: 225
Joined: 22 Aug 2012 21:37
Been thanked: 29 times
Contact:
Status: Offline

Downloader Settings

Postby mano3m » 17 Nov 2013 23:57

<reserved>

mano3m
Recognized Developer
Posts: 225
Joined: 22 Aug 2012 21:37
Been thanked: 29 times
Contact:
Status: Offline

Provider Settings

Postby mano3m » 17 Nov 2013 23:58

<reserved>


Return to “FAQ”