Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 2.51 KB

from_deluge.md

File metadata and controls

56 lines (49 loc) · 2.51 KB
title description published date tags editor dateCreated
from_deluge
true
2022-12-05 03:51:51 UTC
dependencies
markdown
2022-09-18 05:05:28 UTC

Deluge Input Plugin

Requires installing deluge-client via pip {.is-warning}

This plugin creates an entry for each torrent that is currently loaded in Deluge (with optional filters.) It is useful for learning items you have manually added to Deluge into your FlexGet database, or changing settings (or renaming, moving) of torrents currently running in Deluge.

Options

Main options
host Hostname or IP of Deluge daemon. (default localhost)
port Port to connect to Deluge daemon. (default 58846)
username Deluge username (defaults to automatic local client authentication if not specified)
password Deluge password (defaults to automatic local client authentication if not specified)
config_path The path to your Deluge config folder. (must be specified for .torrent files to be available)
filter Criteria can be specified to limit which items from Deluge will have entries created.
Filter options
label Match torrents with the specified label.
state Can be 'active', 'downloading', 'seeding', 'queued' or 'paused'

Entry Fields

This plugin passes on all information provided by deluge on as entry fields. The names of these fields will all be prefixed with deluge_. The naming may vary slightly depending on deluge version.

To get a full listing of fields provided, run the following command:

flexget --test execute --tasks <name of from_deluge task> --dump

Here are some of the more common entry fields which will be created:

Field Description
deluge_state Current state in Deluge, e.g. 'Downloading'
deluge_progress Current percentage completed.
deluge_label Label from Deluge
deluge_save_path Deluge download location
deluge_move_completed_path Deluge move completed path
deluge_ratio Deluge stop ratio
torrent_info_hash The info hash for the torrent
torrent_seeds The current number of seeds for the torrent
torrent_peers The current number of peers for the torrent
torrent_private A flag that indicates if this torrent is private
content_size Size in MB of the content
content_files List of the filenames in the torrent
(the following fields are only available if config_path is specified)
location Path to torrent file
url Path to torrent file in 'file://' format