Difference between revisions of "Deluge"

From ArchWiki
Jump to: navigation, search
(needs a total re-write (work in progress))
m (Style updates)
(37 intermediate revisions by 5 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 three options for interaction 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}}
  
==Install==
+
[http://deluge-torrent.org/ Deluge] is a lightweight but full-featured BitTorrent application written in Python 2. 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].
[[pacman| Install]] {{Pkg|deluge}} from the [[official repositories]].
+
  
==Configuration==
+
== Installation ==
If you want to run Deluge as user just run:
+
# deluge -u [gtk|web|console]
+
  
===daemon===
+
{{Pkg|deluge}} is available from the [[official repositories]].
Please note, deluge works perfectly fine without its daemon running. The install process should create the defaults "deluge" user and group, with user deluge being a member of group deluge. You can change deluge's default user or group in deluge.conf
+
  
 +
The GTK+ UI requires additional dependencies as does the Web UI. Inspect the pacman output to determine which are right for the intended application:
 +
{{Pkg|python2-notify}}: libnotify notifications
 +
{{Pkg|pygtk}}: needed for gtk ui
 +
{{Pkg|librsvg}}: needed for gtk ui
 +
{{Pkg|python2-mako}}: needed for web ui
  
In case of systemd journal logging errors, it be necessary to copy /usr/lib/tmpfiles.d/deluge.conf to /etc/tmpfiles.d.
+
== 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 {{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.
  
The rest of this guide will assume you use the default '''deluge''' user. This is that user's default home directory and therefore its configuration location is in {{ic|/srv/deluge}}. This should be fine under most circumstances. Note that this is NOT the default download location, it only holds its configuration and ssl certificates. You will be able to change all other options later on once you get a client working.
+
=== System service ===
  
Next, start the [[daemon]] to generate its default configuration in its home directory:
+
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'''.
  
==Graphical Clients==
+
=== User service ===
  
===GTK UI===
+
A user service will allow {{ic|deluged}} to run when {{ic|systemd --user}} is started. This is accomplished by creating a user service file:
The GTK UI needs to have {{Pkg|pygtk}} and {{Pkg|librsvg}} installed on the clients.
+
{{hc|/etc/systemd/user/deluged.service|<nowiki>
If the deluge daemon is running stop it.
+
[Unit]
 +
Description=Deluge Daemon
 +
After=network.target
  
In order to connect remotely via the GTK UI, there should be something like this in {{ic|/srv/deluge/.config/deluge/core.conf}}:
+
[Service]
"allow_remote": true,
+
Exec=/usr/bin/deluged -d -P %h/.config/deluge/deluge.pid
  
Now add yourself to the authentification file:
+
[Install]
  # echo "yourusername:yourpassword:10" >> /srv/deluge/.config/deluge/auth
+
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
  
The authentification level is not used at this time. Read [http://dev.deluge-torrent.org/wiki/UserGuide/Authentication more] about that.
+
The {{ic|deluged}} user service can also be placed in {{ic|$HOME/.config/systemd/user/}}. See [[systemd/User]] for more information on user services.
  
Start the Deluge daemon again.
+
== Configuration ==
  
Now start the GTK UI. If you prefer, you can edit the preferences in {{ic|~/.config/deluge/gtkui.conf}}, but there's also a nice configuration tool in the UI.
+
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/}}.
  
Look for '''classic mode''' and disable it. Then go to Edit -> Connection Manager and add your daemon.
+
=== Firewall ===
  
===Web UI===
+
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:
The web UI daemon runs on the server and the clients only need a web browser. You need to install {{Pkg|python2-mako}} on the server.
+
# 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.}}
  
First, start the web UI [[daemon]], named ''deluge-web'', and login at {{ic|http://''ip-address'':8112}}. Where ''ip-address'' is the name of your Deluge server or its private or public IP address. When asked for a password, enter "deluge" as it is the default password.
+
== Clients ==
  
The preferences in the web UI should be rather self explanatory and the first obvious thing to do is to change your password.
+
=== Console ===
  
====Automatically Connect To Daemon====
+
The console client can be run with:
If you want to avoid clicking "connect" everytime you start the Deluge web UI, edit the {{ic|web.conf}} file in your configuration directory (usually {{ic|/srv/deluge/.config/deluge}}). 
+
$ deluge-console
It should have a line like this towards the bottom:
+
Enter the {{ic|help}} command for a list of available commands.
'''
+
"default_daemon": ""
+
  
Change it to:
+
=== GTK+ ===
'''
+
"default_daemon": "127.0.0.1:58846"
+
  
This assumes that your Deluge port is the default 58846.
+
{{Note|If you plan on using the daemon (server) functionality, it is wise to disable Classic Mode in ''Edit -> Preferences -> Interface'', then restart the client.}}
 +
The GTK+ client can be run with:
 +
$ deluge-gtk
 +
or:
 +
$ deluge
  
====SSL====
+
The GTK+ client has a number of useful plugins:
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/}}:
+
* 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
  
# openssl req -new -x509 -nodes -out deluge.cert.pem -keyout deluge.key.pem
+
=== Web ===
  
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:
+
{{Note|It is recommended that you use https for the Web client.}}
...
+
{{Warning|
"pkey": "ssl/deluge.key.pem",
+
* If multiple users are running a daemon, the default port (8112) will need to be changed for each user.
...
+
* The deluge Web client comes with a default password. See the Setup section.
"cert": "ssl/deluge.cert.pem",
+
}}
...
+
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.
"https": true,
+
  
Afterwards just start the web UI daemon again.
+
==== System service ====
  
====Apache configuration====
+
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}}.
  
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}}.
+
==== User service ====
  
Uncomment the Virtual Hosts line:
+
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
  
Include conf/extra/httpd-vhosts.conf
+
[Service]
 +
Exec=/usr/bin/deluge-web --ssl
  
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:
+
[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
  
{{bc|<VirtualHost *:80>
+
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.
    ServerAlias subdomain.example.com
+
 
    ProxyRequests off
+
==== Setup ====
    ProxyPass / http://127.0.0.1:8112/
+
 
    ProxyPassReverse / http://127.0.0.1:8112/
+
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.
</VirtualHost>
+
 
 +
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 {{ic|$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'''!
 +
* The user/password in this file are not hashed or salted like in the web client config.
 
}}
 
}}
  
==Troubleshooting==
+
The number '''10''' corresponds to a level of '''Admin'''.  Refer to the following table for additional values:
=== Magnet Links Are Broken with Chromium ===
+
 
The following command should return "deluge.desktop":
+
{| class="wikitable" align="center"
  $ xdg-mime query default "x-scheme-handler/magnet"
+
|-
 +
! 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 {{ic|$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 it returns a null, run this command:
+
If you are behind a NAT router/firewall, a port forward is also required there to access the daemon from outside the network.
$ xdg-mime default deluge.desktop application/x-bittorrent x-scheme-handler/magnet
+
  
Reference: https://bugs.archlinux.org/task/28011
+
=== Connect ===
  
=== Downloads don't start ===
+
In the console client:
As of libtorrent-rasterbar version 0.16, Deluge will not download torrents that are added by a magnet link.
+
connect <host>[:<port>] <user> <password>
* 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:
+
In the GTK+ client, ''Edit > Connection Manager > Add''.
https://projects.archlinux.org/svntogit/packages.git/tree/trunk?h=packages/libtorrent-rasterbar&id=da6a845f1f66026c2e0df71e8728ab0d8fd660b0
+
  
=== Web UI doesn't store settings ===
+
In the Web client, ''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|...
+
== See Also ==
"enc_prefer_rc4": true,
+
"listen_ports": [
+
  49160,
+
  49249
+
],
+
"dht": false,
+
...}}
+
  
=== Daemon won't start on fresh install ===
+
* [http://deluge-torrent.org/ Deluge homepage]
There seems to be an issue creating a folder with the correct permissions when the package installs, try:
+
* [http://dev.deluge-torrent.org/wiki Deluge wiki]
# chmod u+x /srv/deluge
+

Revision as of 21:50, 29 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 Python 2. 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.

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, then restart 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

Note: It is recommended that you use https for the Web client.
Warning:
  • If multiple users are running a daemon, the default port (8112) will need to be changed for each user.
  • 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!
  • 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