Difference between revisions of "Deluge"

From ArchWiki
Jump to: navigation, search
(Deluge-Web (Optional))
m (Added "allow_remote" setting change. The console connect yield "connection refused" otherwise.)
(25 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
[[Category:Internet Applications]]
 
[[Category:Internet Applications]]
 
{{Article summary start}}
 
{{Article summary start}}
{{Article summary text|Deluge is a lightweight, BitTorrent client written in python that offers users a powerful client/server architecture.  Once a headless daemon has been setup, user can interact with it in three ways including a WebUI, GTK-UI, and console interface.}}
+
{{Article summary text|A lightweight, full-featured BitTorrent application with a client/server model}}
{{Article summary heading|Related Articles}}
+
{{Article summary heading|Related}}
{{Article summary wiki|PeerGuardian Linux}}
+
{{Article summary wiki|rTorrent}}
{{Article summary wiki|Ufw}}
+
{{Article summary wiki|systemd}}
 +
{{Article summary wiki|systemd/User}}
 +
{{Article summary wiki|iptables}}
 +
{{Article summary wiki|OpenSSL}}
 +
{{Article summary heading|External Links}}
 +
{{Article summary text|[http://deluge-torrent.org/ Deluge Homepage]}}
 +
{{Article summary text|[http://dev.deluge-torrent.org/wiki Deluge Wiki]}}
 
{{Article summary end}}
 
{{Article summary end}}
 +
 +
[http://deluge-torrent.org/ Deluge] is a lightweight but full-featured BitTorrent application written in python2. It has a variety of features, including but not limited to: a client/server model, DHT support, magnet links, a plugin system, UPnP support, full-stream encryption, proxy support, and three different client applications. When the server daemon is running, users can connect to it via a console client, a gtk-based GUI, or a Web-based UI. A full list of features can be viewed [http://dev.deluge-torrent.org/wiki/About here].
  
 
==Installation==
 
==Installation==
Line 14: Line 22:
 
  # pacman -S deluge
 
  # pacman -S deluge
  
The gtk UI requires additional dependencies as does the webui.  Inspect the pacman output to determine which are right for the intended application.
+
The gtk UI requires additional dependencies as does the Web UI.  Inspect the pacman output to determine which are right for the intended application.
 
  python2-notify: libnotify notifications
 
  python2-notify: libnotify notifications
 
  pygtk: needed for gtk ui
 
  pygtk: needed for gtk ui
Line 20: Line 28:
 
  python2-mako: needed for web ui
 
  python2-mako: needed for web ui
  
==Daemon Setup==  
+
==Daemon Setup==
Deluge can run as a system daemon which is accessible to any system user or it can run in a non-daemon mode. The focus of this article is on the daemon mode of operation.
+
{{Warning|If multiple users are running a daemon, the default port (58846) will need to be changed for each user.}}
 +
Deluge comes with a daemon called {{ic|deluged}}. If it is not running when one of the clients is run, it will be started. It is useful, however, to have it started with systemd to allow torrents to run without starting a client and/or Xorg. This can be accomplished in one of two ways: a system service or a user service.
  
{{Note|Advanced users are free to edit the configuration files in the deluge daemon home directory {{ic|/srv/deluge/.config/}} manually or from the {{ic|/usr/bin/deluge-console}}. The rest of this guide is written using the gtk client to do this from convenience of a GUI.}}
+
===System Service===
 +
A system service will allow {{ic|deluged}} to run at boot without the need to start Xorg or a client. Deluge comes with a system service called {{ic|deluged.service}}, which can be started and enabled without change:
 +
# systemctl start deluged
 +
# systemctl enable deluged
 +
This will run the deluge daemon as the '''deluge''' user, which is created by the deluge package. If you wish to run the daemon as another user, copy {{ic|/usr/lib/systemd/system/deluged.service}} to {{ic|/etc/systemd/system/deluged.service}} and change the User parameter within the file, such as the '''torrent''' user:
 +
User='''torrent'''
 +
In that case, you will have to create a user called '''torrent'''.
  
Start the deluge backend daemon like any other systemd service:
+
===User Service===
  # systemd start deluged
+
A user service will allow {{ic|deluged}} to run when {{ic|systemd --user}} is started. This is accomplished by creating a user service file:
 +
  {{hc|/etc/systemd/user/deluged.service|<nowiki>
 +
[Unit]
 +
Description=Deluge Daemon
 +
After=network.target
  
=== Create a User ===
+
[Service]
To allow interaction with the daemon, create a user:password:level in {{ic|/srv/deluge/.config/deluge/auth}}. 
+
Exec=/usr/bin/deluged -d -P %h/.config/deluge/deluge.pid
For example:
+
# echo "delugeuser:p422WoRd:10" >> /srv/deluge/.config/deluge/auth
+
{{Note|The user/password created does not have to match any system users... and to maintain good security practices it should NOT!}}
+
  
The number '''10''' corresponds to a level of 'Admin.' Refer to the following table for additional values:
+
[Install]
 +
WantedBy=default.target
 +
  </nowiki>}}
 +
The deluge user service can now be started and enabled by the user:
 +
$ systemctl --user start deluged
 +
$ systemctl --user enable deluged
  
{| class="wikitable" align="center"
+
The {{ic|deluged}} user service can also be placed in {{ic|$HOME/.config/systemd/user/}}. See [[systemd/User]] for more information on user services.
|-
+
! Level Name !! Level Value
+
|-
+
| None || 0
+
|-
+
|Read Only || 1
+
|-
+
| Normal || 5
+
|-
+
| Admin || 10
+
|}
+
  
{{Note|In Deluge 1.35, these values have no effect, but multiuser options are under development.}}
+
==Configuration==
 +
Deluge can be configured through any of the clients as well as by simply editting the JSON-formatted configuration files located in {{ic|$HOME/.config/deluge/}}. '''$HOME''' refers to the home directory of the user that {{ic|deluged}} is running as. This means that if the daemon is running as the '''deluge''' user, the default home directory is {{ic|/srv/deluge/}}.
  
=== Define Options ===
+
===Firewall===
#Load the gtk client {{ic|/usr/bin/deluge-gtk}}  
+
Deluge requires at least one port open for TCP and UDP to allow incoming connections for seeding. If deluge is informing you that it cannot open a port for incoming connections, you must open ports you wish to use. In this example, ports 56881 through 56889 are opened for TCP and UDP:
#Disable '''classic mode''' from the Edit>Preferences>Interface.
+
# iptables -A INPUT -p tcp --dport 56881:56889 -j ACCEPT
 +
# iptables -A INPUT -p udp --dport 56881:56889 -j ACCEPT
 +
If you are behind a NAT router/firewall, port forwards are also required there. UPnP may also be used, but that will not work with the local firewall on the system that the daemon is running on because it requires predefined ports.
 +
{{Note|You can limit this to just one port, but you must open any ports for both TCP and UDP.}}
  
A restart of the client is required for these changes to take effect. Exit the client and reload it.
+
==Clients==
 +
===Console===
 +
The console client can be run with:
 +
  $ deluge-console
 +
Enter the {{ic|help}} command for a list of available commands.
  
#Setup the client to point to the daemon from Edit>Connection Manager.
+
===Gtk===
#Delete the dummy server by hightlighting it and clicking the "Remove" button.
+
{{Note|If you plan on using the daemon (server) functionality, it is wise to disable Classic Mode in '''Edit -> Preferences -> Interface'''. '''''This requires a restart of the client.'''''}}
#Create an entry to the daemon via the "Add" button populating the resulting dialog with either the IP address or the word "localhost" as the hostname. Populate the "Username" and "Password" fields with the username and password used in the daemons setup. and then click the "+ Add" button.
+
The gtk client can be run with:
 +
$ deluge-gtk
 +
or:
 +
  $ deluge
  
Hostname: localhost
+
The gtk client has a number of useful plugins:
Username: delugeuser
+
* AutoAdd - Monitors directories for .torrent files
Password: p422WoRd:10
+
* Blocklist - Downloads and imports an IP blocklist
 +
* Execute - Event-based command execution
 +
* Extractor - Extracts archived files upon completion '''''(beware of random high disk I/O usage)'''''
 +
* Label - Allows labels to be assigned to torrents, as well as state, tracker, and keyword filters
 +
* Notifications - Provides notifications (email, pop-up, blink, sound) for events as well as other plugins
 +
* Scheduler - Limits active torrents and their speed on a per-hour, per-day basis
 +
* WebUi - Allows the Web UI to be started via the gtk client
  
If the correct credentials were populated, a green light should appear options for interaction  adjacent to the name of the server.  To connect, hit the "Connect" button.
+
===Web===
 +
{{Warning|If multiple users are running a daemon, the default port (8112) will need to be changed for each user.}}
 +
{{Note|It is recommended that you use '''https''' for the Web client.}}
 +
{{Warning|The deluge Web client comes with a default password. See the Setup section.}}
 +
The Web UI can be started by running {{ic|deluge-web}}, through a plugin in the gtk UI, or via systemd. It has many of the same features of the gtk UI, including the plugin system.
  
Users can now configure their server from the GUI. Most of the options are self explanatory and intuitive. More details are available on the official [http://dev.deluge-torrent.org/wiki/UserGuide/BandwidthTweaking Deluge wiki] for details.
+
====System Service====
 +
Deluge comes with a system service file called {{ic|deluge-web.service}}. The process for this is the same as starting {{ic|deluged.service}}, except with {{ic|deluge-web}} instead of {{ic|deluged}}. This service will also run as the '''deluge''' user unless the service file is modified in the same way as {{ic|deluged.service}}.
  
{{Note|When defining paths under Preferences>Downloads make sure that the the '''deluge''' user has read/write access to whatever is defined. Remember that the daemon is running as system user '''deluge''' in system group '''deluge'''!}}
+
====User Service====
{{Note|If the expectation exists to allow access from other machines, be sure to enable Preferences>Daemon>Connections>Allow Remote Connections.}}
+
A user service will allow {{ic|deluge-web}} to run when {{ic|systemd --user}} is started. This is accomplished by creating a user service file:
 +
{{hc|/etc/systemd/user/deluge-web.service|<nowiki>
 +
[Unit]
 +
Description=Deluge Web UI
 +
After=deluged.service
  
== Interacting with the Daemon ==
+
[Service]
As previously mentioned, users have three options to connect to the daemon:
+
Exec=/usr/bin/deluge-web --ssl
#Deluge-GTK
+
#Deluge-Web
+
#Deluge-console
+
  
The gtk client has already been covered in the previous section.
+
[Install]
 +
WantedBy=default.target
 +
</nowiki>}}
 +
The deluge user service can now be started and enabled by the user:
 +
$ systemctl --user start deluge-web
 +
$ systemctl --user enable deluge-web
  
===Deluge-Web (Optional) ===
+
The {{ic|deluge-web}} user service can also be placed in {{ic|$HOME/.config/systemd/user/}}. See [[systemd/User]] for more information on user services.
To run the web ui, simply start the web-daemon:
+
# systemctl start deluge-web
+
  
Point a browser to {{ic|http://localhost:8112}}. Substitute the word '''localhost''' with an IP address if the server is elsewhere.
+
====Setup====
When asked for a password, enter "deluge" as it is the default password.
+
When {{ic|deluge-web}} is initially started, it will create {{ic|$HOME/.config/deluge/web.conf}}. The password in this file is hashed with SHA1 and salted. The default password is '''deluge'''. On the first visit, you will be advised to change the password.  
  
The preferences in the web UI is ''highly'' similar to the gtk UI. As explained in the previous section, edit the connection manager and define an entry to the daemon using the same credentials used in the setup step. Once finished, users are free to remove the dummy server entry.
+
You will also be greeted by a warning from your browser that the SSL certificate is untrusted. You must add an exception to this in your browser to continue on. See the [[OpenSSL]] page for information on creating your own certificate.
  
Hostname: localhost
+
==Headless Setup==
Username: delugeuser
+
Deluge is quite useful on a headless system, often referred to as a seed box, because of its client/server model. To set up deluge on a headless system, set up the daemon as shown above.
Password: p422WoRd:10
+
  
=== Deluge-Console (Optional) ===
+
===Create a User===
The CLI client {{ic|/usr/bin/deluge-consle}} can also be used to connect to a running daemon. Invoke it from a shell.  To connect, simply type:
+
To allow interaction with the server remotely, create a user in {{ic|$HOME/.config/deluge/auth}}. For example:
  connect localhost delugeuser p422WoRd:10
+
  $ echo "delugeuser:p422WoRd:10" >> $HOME/.config/deluge/auth
 +
{{Note|The user/password created does not have to match any system users, and to maintain good security practices it should NOT!}}
 +
{{Note|The user/password in this file are not hashed or salted like in the web client config.}}
  
 +
The number '''10''' corresponds to a level of '''Admin'''.  Refer to the following table for additional values:
  
====SSL====
+
{| class="wikitable" align="center"
In case you want SSL for the web UI, you need to generate a new cert/key set. To do this, first stop the web UI daemon and then append to {{ic|/srv/deluge/.config/deluge/ssl/}}:
+
|-
 +
! Level Name !! Level Value
 +
|-
 +
| None || 0
 +
|-
 +
|Read Only || 1
 +
|-
 +
| Normal || 5
 +
|-
 +
| Admin || 10
 +
|}
  
# openssl req -new -x509 -nodes -out deluge.cert.pem -keyout deluge.key.pem
+
{{Note|In Deluge 1.35, these values have no effect, but multiuser options are under development.}}
 
+
Next you need to edit {{ic|/srv/deluge/.config/deluge/web.conf}} and change the '''pkey''' and '''cert''' configuration directives to use your new self-signed certificates and also enable SSL:
+
...
+
"pkey": "ssl/deluge.key.pem",
+
...
+
"cert": "ssl/deluge.cert.pem",
+
...
+
"https": true,
+
 
+
Afterwards just start the web UI daemon again.
+
 
+
====Apache configuration====
+
 
+
As of this writing, it is possible to use ProxyPass and ProxyPassReverse with Apache to run your Deluge web UI with a web server. To do so, add the following lines to your {{ic|httpd.conf}}.
+
 
+
Uncomment the Virtual Hosts line:
+
 
+
Include conf/extra/httpd-vhosts.conf
+
 
+
That is all the editing that needs to be done for the {{ic|httpd.conf}}. Next, navigate to the {{ic|extra/}} folder and edit the {{ic|httpd-vhosts.conf}} file. Append to the file, the following:
+
 
+
{{bc|<VirtualHost *:80>
+
    ServerAlias subdomain.example.com
+
    ProxyRequests off
+
    ProxyPass / http://127.0.0.1:8112/
+
    ProxyPassReverse / http://127.0.0.1:8112/
+
</VirtualHost>
+
}}
+
  
==Troubleshooting==
+
===Allow Remote===
=== Magnet Links Are Broken with Chromium ===
+
The following command should return "deluge.desktop":
+
$ xdg-mime query default "x-scheme-handler/magnet"
+
  
If it returns a null, run this command:
+
The default settings disallow remote connections. Change the "allow_remote" setting in $HOME/.config/deluge/core.conf:
$ xdg-mime default deluge.desktop application/x-bittorrent x-scheme-handler/magnet
+
"allow_remote": true,
  
Reference: https://bugs.archlinux.org/task/28011
+
===Firewall===
 +
You will need to open the port for remote access. The following example uses the default daemon port (58846):
 +
# iptables -A INPUT -p tcp --dport 58846 -j ACCEPT
 +
See [[iptables]] for more information on firewall rules.
  
=== Downloads don't start ===
+
If you are behind a NAT router/firewall, a port forward is also required there to access the daemon from outside the network.
As of libtorrent-rasterbar version 0.16, Deluge will not download torrents that are added by a magnet link.
+
* https://bugs.archlinux.org/task/29414
+
* https://bbs.archlinux.org/viewtopic.php?id=151249
+
  
Downgrading libtorrent-rasterbar to 1:0.16.3-1 should fix it. Use the following PKGBUILD:
+
===Connect===
https://projects.archlinux.org/svntogit/packages.git/tree/trunk?h=packages/libtorrent-rasterbar&id=da6a845f1f66026c2e0df71e8728ab0d8fd660b0
+
In the console client:
 +
connect <host>[:<port>] <user> <password>
  
=== Web UI doesn't store settings ===
+
In the gtk client, {{ic|'''Edit -> Connection Manager -> Add'''}}.
For some yet unknown reason, the web interface with Deluge 1.3.3 refuses to properly store the incoming (listen) ports configuration. This can manually be edited in core.conf. The Deluge bugtracker mentions this is fixed, it is not in 1.3.3.
+
  
{{hc|/srv/deluge/.config/deluge/core.conf|...
+
In the Web client, {{ic|'''Connection Manager -> Add'''}}.
"enc_prefer_rc4": true,
+
"listen_ports": [
+
  49160,
+
  49249
+
],
+
"dht": false,
+
...}}
+
  
=== Daemon won't start on fresh install ===
+
==See Also==
There seems to be an issue creating a folder with the correct permissions when the package installs, try:
+
* [http://deluge-torrent.org/ Deluge homepage]
# chmod u+x /srv/deluge
+
* [http://dev.deluge-torrent.org/wiki Deluge wiki]

Revision as of 02:53, 2 August 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary heading Template:Article summary text Template:Article summary text Template:Article summary end

Deluge is a lightweight but full-featured BitTorrent application written in python2. It has a variety of features, including but not limited to: a client/server model, DHT support, magnet links, a plugin system, UPnP support, full-stream encryption, proxy support, and three different client applications. When the server daemon is running, users can connect to it via a console client, a gtk-based GUI, or a Web-based UI. A full list of features can be viewed here.

Installation

deluge is available from the official repositories.

# pacman -S deluge

The gtk UI requires additional dependencies as does the Web UI. Inspect the pacman output to determine which are right for the intended application.

python2-notify: libnotify notifications
pygtk: needed for gtk ui
librsvg: needed for gtk ui
python2-mako: needed for web ui

Daemon Setup

Warning: If multiple users are running a daemon, the default port (58846) will need to be changed for each user.

Deluge comes with a daemon called deluged. If it is not running when one of the clients is run, it will be started. It is useful, however, to have it started with systemd to allow torrents to run without starting a client and/or Xorg. This can be accomplished in one of two ways: a system service or a user service.

System Service

A system service will allow deluged to run at boot without the need to start Xorg or a client. Deluge comes with a system service called deluged.service, which can be started and enabled without change:

# systemctl start deluged
# systemctl enable deluged

This will run the deluge daemon as the deluge user, which is created by the deluge package. If you wish to run the daemon as another user, copy /usr/lib/systemd/system/deluged.service to /etc/systemd/system/deluged.service and change the User parameter within the file, such as the torrent user:

User=torrent

In that case, you will have to create a user called torrent.

User Service

A user service will allow deluged to run when systemd --user is started. This is accomplished by creating a user service file:

/etc/systemd/user/deluged.service
[Unit]
Description=Deluge Daemon
After=network.target

[Service]
Exec=/usr/bin/deluged -d -P %h/.config/deluge/deluge.pid

[Install]
WantedBy=default.target
 

The deluge user service can now be started and enabled by the user:

$ systemctl --user start deluged
$ systemctl --user enable deluged

The deluged user service can also be placed in $HOME/.config/systemd/user/. See systemd/User for more information on user services.

Configuration

Deluge can be configured through any of the clients as well as by simply editting the JSON-formatted configuration files located in $HOME/.config/deluge/. $HOME refers to the home directory of the user that deluged is running as. This means that if the daemon is running as the deluge user, the default home directory is /srv/deluge/.

Firewall

Deluge requires at least one port open for TCP and UDP to allow incoming connections for seeding. If deluge is informing you that it cannot open a port for incoming connections, you must open ports you wish to use. In this example, ports 56881 through 56889 are opened for TCP and UDP:

# iptables -A INPUT -p tcp --dport 56881:56889 -j ACCEPT
# iptables -A INPUT -p udp --dport 56881:56889 -j ACCEPT

If you are behind a NAT router/firewall, port forwards are also required there. UPnP may also be used, but that will not work with the local firewall on the system that the daemon is running on because it requires predefined ports.

Note: You can limit this to just one port, but you must open any ports for both TCP and UDP.

Clients

Console

The console client can be run with:

$ deluge-console

Enter the help command for a list of available commands.

Gtk

Note: If you plan on using the daemon (server) functionality, it is wise to disable Classic Mode in Edit -> Preferences -> Interface. This requires a restart of the client.

The gtk client can be run with:

$ deluge-gtk

or:

$ deluge

The gtk client has a number of useful plugins:

  • AutoAdd - Monitors directories for .torrent files
  • Blocklist - Downloads and imports an IP blocklist
  • Execute - Event-based command execution
  • Extractor - Extracts archived files upon completion (beware of random high disk I/O usage)
  • Label - Allows labels to be assigned to torrents, as well as state, tracker, and keyword filters
  • Notifications - Provides notifications (email, pop-up, blink, sound) for events as well as other plugins
  • Scheduler - Limits active torrents and their speed on a per-hour, per-day basis
  • WebUi - Allows the Web UI to be started via the gtk client

Web

Warning: If multiple users are running a daemon, the default port (8112) will need to be changed for each user.
Note: It is recommended that you use https for the Web client.
Warning: The deluge Web client comes with a default password. See the Setup section.

The Web UI can be started by running deluge-web, through a plugin in the gtk UI, or via systemd. It has many of the same features of the gtk UI, including the plugin system.

System Service

Deluge comes with a system service file called deluge-web.service. The process for this is the same as starting deluged.service, except with deluge-web instead of deluged. This service will also run as the deluge user unless the service file is modified in the same way as deluged.service.

User Service

A user service will allow deluge-web to run when systemd --user is started. This is accomplished by creating a user service file:

/etc/systemd/user/deluge-web.service
[Unit]
Description=Deluge Web UI
After=deluged.service

[Service]
Exec=/usr/bin/deluge-web --ssl

[Install]
WantedBy=default.target
 

The deluge user service can now be started and enabled by the user:

$ systemctl --user start deluge-web
$ systemctl --user enable deluge-web

The deluge-web user service can also be placed in $HOME/.config/systemd/user/. See systemd/User for more information on user services.

Setup

When deluge-web is initially started, it will create $HOME/.config/deluge/web.conf. The password in this file is hashed with SHA1 and salted. The default password is deluge. On the first visit, you will be advised to change the password.

You will also be greeted by a warning from your browser that the SSL certificate is untrusted. You must add an exception to this in your browser to continue on. See the OpenSSL page for information on creating your own certificate.

Headless Setup

Deluge is quite useful on a headless system, often referred to as a seed box, because of its client/server model. To set up deluge on a headless system, set up the daemon as shown above.

Create a User

To allow interaction with the server remotely, create a user in $HOME/.config/deluge/auth. For example:

$ echo "delugeuser:p422WoRd:10" >> $HOME/.config/deluge/auth
Note: The user/password created does not have to match any system users, and to maintain good security practices it should NOT!
Note: The user/password in this file are not hashed or salted like in the web client config.

The number 10 corresponds to a level of Admin. Refer to the following table for additional values:

Level Name Level Value
None 0
Read Only 1
Normal 5
Admin 10
Note: In Deluge 1.35, these values have no effect, but multiuser options are under development.

Allow Remote

The default settings disallow remote connections. Change the "allow_remote" setting in $HOME/.config/deluge/core.conf:

"allow_remote": true,

Firewall

You will need to open the port for remote access. The following example uses the default daemon port (58846):

# iptables -A INPUT -p tcp --dport 58846 -j ACCEPT

See iptables for more information on firewall rules.

If you are behind a NAT router/firewall, a port forward is also required there to access the daemon from outside the network.

Connect

In the console client:

connect <host>[:<port>] <user> <password>

In the gtk client, Edit -> Connection Manager -> Add.

In the Web client, Connection Manager -> Add.

See Also