Difference between revisions of "Deluge"

From ArchWiki
Jump to: navigation, search
(Deluge-Web (Optional))
(Daemon Setup)
Line 21: Line 21:
  
 
==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.
+
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.  Users wishing a more simplistic setup, i.e. running {{ic|/usr/bin/deluged}} as them-self should be able to read on and simply substitute the systemctl commands for the live files on the system.
  
 
{{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.}}
 
{{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.}}

Revision as of 17:02, 1 January 2013

Summary help replacing me
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.
Related Articles
PeerGuardian Linux
Ufw

Installation

deluge is available from the official repositories.

# 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.

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

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. Users wishing a more simplistic setup, i.e. running /usr/bin/deluged as them-self should be able to read on and simply substitute the systemctl commands for the live files on the system.

Note: Advanced users are free to edit the configuration files in the deluge daemon home directory /srv/deluge/.config/ manually or from the /usr/bin/deluge-console. The rest of this guide is written using the gtk client to do this from convenience of a GUI.

Start the deluge backend daemon like any other systemd service:

# systemd start deluged

Create a User

To allow interaction with the daemon, create a user:password:level in /srv/deluge/.config/deluge/auth. 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:

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.

Define Options

  1. Load the gtk client /usr/bin/deluge-gtk
  2. Disable classic mode from the Edit>Preferences>Interface.

A restart of the client is required for these changes to take effect. Exit the client and reload it.

  1. Setup the client to point to the daemon from Edit>Connection Manager.
  2. Delete the dummy server by hightlighting it and clicking the "Remove" button.
  3. 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.
Hostname: localhost
Username: delugeuser
Password: p422WoRd:10

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.

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 Deluge wiki for details.

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!
Note: If the expectation exists to allow access from other machines, be sure to enable Preferences>Daemon>Connections>Allow Remote Connections.

Interacting with the Daemon

As previously mentioned, users have three options to connect to the daemon:

  1. Deluge-GTK
  2. Deluge-Web
  3. Deluge-console

Deluge-Gtk

The gtk client has already been covered in the previous section. Users should now have a fully functional client.

Deluge-Web (Optional)

Warning: Running the web client without encryption can be a bad idea. It is therefore recommended that users enable https.

To enable encrypted connections to/from the daemon, simply edit the https variable in /srv/deluge/.config/deluge/web.conf changing the default value of false to true as shown:

"https": true,

Take note of the doublequotes and the trailing comma!

Users wishing to regenerate self-signed certificates can refer to this link.

To run the web ui, simply start the web-daemon:

# systemctl start deluge-web

Point a browser to https://localhost:8112. Substitute the word localhost with an IP address if the server is elsewhere. When asked for a password, enter "deluge" as it is the default 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.

Hostname: localhost
Username: delugeuser
Password: p422WoRd:10

Deluge-Console (Optional)

The CLI client /usr/bin/deluge-consle can also be used to connect to a running daemon. Invoke it from a shell. To connect, simply type:

connect localhost delugeuser p422WoRd:10

Troubleshooting

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:

$ xdg-mime default deluge.desktop application/x-bittorrent x-scheme-handler/magnet

Reference: https://bugs.archlinux.org/task/28011

Downloads Don't Start

As of libtorrent-rasterbar version 0.16, Deluge will not download torrents that are added by a magnet link.

Downgrading libtorrent-rasterbar to 1:0.16.3-1 should fix it.