Requires installing
deluge-clientvia pip
Manages torrents within the deluge bittorrent client. Mainly used to add new torrents to deluge, but can also be used to pause/resume/remove torrents already loaded in deluge.
Notes:
deluged as a different user, on a different box, or with a non-default config directory (something other than ~/.config/deluge), you will need to specify the username and password options that you have set up in your Deluge auth file.None of the options are required, and they will all default to whatever you have set in Deluge.
If you do not wish to set any of the parameters the format is:
deluge: yes
| Name | Description |
|---|---|
| host | Deluge host (default localhost) |
| port | Deluge port (default 58846) |
| username | Deluged username (defaults to automatic client authentication if not specified) |
| password | Deluged password (defaults to automatic client authentication if not specified) |
| config_path | If you use a non-standard deluge config folder, specifying this allows automatic authentication to work. |
| action | The action that should be performed on this torrent. add/remove/purge (remove and delete data)/pause/resume (default add) |
| path | The download location |
| move_completed_path | The location files will be moved when torrent finishes (the location will be created if it doesn't exist). |
| label | Label to assign to torrents in Deluge. This field can be a Jinja expression and is rendered before being passed to Deluge. The special value No Label will remove an existing label from a torrent. |
| queue_to_top | If yes will move torrent to top of queue when added, if no will move to bottom. |
| add_paused | If yes, will add the torrents to deluge in the paused state. |
| max_up_speed | Sets the maximum upload speed. Must be specified as a decimal (i.e. 1.0) |
| max_down_speed | Sets the maximum download speed. |
| max_connections | Sets the maximum connections. |
| max_up_slots | Sets the maximum upload slots. |
| ratio | Sets the ratio to stop seeding at. |
| remove_at_ratio | If yes, torrent will be removed from deluge when ratio is reached. |
| compact | If yes, will allocate torrent in compact mode. |
| auto_managed | If set to false torrents will be added to deluge without the automanaged flag. |
| content_filename | Jinja template used to rename the main file and/or directory of the torrent. |
| container_directory | Jinja template used to rename the top-level folder of the torrent. |
| main_file_only | If yes, all files but the main file inside the torrent (the one file with greater than main_file_ratio% of the torrent's total size; 90% by default) will be set to 'do not download' |
| main_file_ratio | Sets the threshold value for main_file_only. Expects a number between 0 and 1 (i.e. 0.85 to change to 85%). 0.9 (90%) by default. |
| magnetization_timeout | When the timeout is set greater than 0 and a magnet URI is added, the task will wait up to the timeout (seconds) for the torrent to magnetize before continuing (Default: 0) |
| hide_sparse_files | If main_file_only is set, all the other (sparse) files will be put inside a hidden subdirectory (called ".sparse_files"). On by default. |
| keep_subs | If main_file_only is set, the subtitle file is also downloaded. If content_filename is set, the subtitle file will be renamed too. If hide_sparse_files is set, the subtitle will not be hidden. On by default. |
| force_recheck | If yes, will perform a data recheck before starting a download. |
deluge:
path: /media/diska/downloads/
move_completed_path: /media/diska/tv/
label: `{{trakt_series_network}}`
queue_to_top: yes
Some plugins allow set to be applied on matched entries.
The deluge plugin will read any of the normal parameters from the entry fields, except for deluge daemon info (host, port, username, password).
Here is an example using the series module:
Example with set:
series:
settings:
720p:
quality: 720p hdtv|webdl
set:
path: /media/diska/incomplete/
move_completed_path: "/media/diska/TV/{{series_name}}/"
label: 720p
hdtv:
quality: hdtv <720p
set:
path: /media/diskb/incomplete/
move_completed_path: "/media/diskb/TV/{{series_name}}/Season {{series_season}}/"
label: tv
720p:
- name 1
- name 2
hdtv:
- name 3
- name 4:
set:
move_completed_path: /media/diskb/otherfolder/
queue_to_top: yes
deluge: yes
The more specific set commands will override the less specific ones (i.e. the set command from name 4 will override the set values from the hdtv group.)
The deluge plugin also supports another advanced feature: content file renaming. This will allow you to change the name of the main file and directory of the torrent in deluge. It will only rename a file/directory if it finds that one file in the torrent is larger than 90% (or specified value) of the total torrent content.
Specifying a directory as part of the content_filename is optional. Not doing so will leave the torrent folder structure alone, just renaming the file.
Here is an example configuration:
series:
settings:
groupa:
set:
content_filename: "\{{series_name}} - \{{series_id}} - \{{quality}}"
move_completed_path: /home/user/TV/\{{series_name}}/Season \{{series_season}}/
groupa:
- Show Name
deluge: yes
This config uses Jinja2 notation to rename the file using information from the series parser. If there was a file called Show.Name.9x15.REPACK.720p.HDTV.x264-FOOBAR.mkv inside the torrent, it would be renamed to Show Name - S09E15 - 720p.mkv If there is already a file with the new name present in either the downloading folder, or movedone folder, a trailing number will be added to the filename. i.e. Show Name - S09E15 - 720p(2).mkv
Together with the movedone command, this means all TV series will be downloaded to:
/home/user/TV/Show Name/Season #/Show Name - S##E##/Show Name - S##E## - quality.ext
Subtitle files will be downloaded to (see the keep_subs option):
/home/user/TV/Show Name/Season #/Show Name - S##E##/Show Name - S##E## - quality.srt
NOTE: In order to perform content renaming on a magnet URI, you must set magnetization_timeout to a value greater than 0 so that flexget has a chance to magnetize the torrent and retrieve the file list before performing any file list processing during the content renaming phase. If you use any feeds that supply magnet URIs and you wish to perform content renaming, it is strongly recommended to set magnetization_timeout to a reasonable wait period, such as 30 (seconds). Magnetization time varies based on swarm activity and network speed, but is typically completed in under 10 seconds.
You can ignore messages about disconnecting from the daemon in a 'non-clean' fashion. This is normal on Windows.