Whatbox Logo
Login for certain variables to be updated with your slot's information

Wiki > Deluge

Deluge is a full-featured open source BitTorrent client. It uses libtorrent in its backend and features multiple user interfaces. It has been designed using the client server model. The Deluge daemon is able to run on the server and handle all bittorrent activity while user interfaces are able to connect remotely from any platform.

Interfaces

WebUI

The Web user interface offers easy access to Deluge from a web browser.

No configuration is necessary to use the Deluge WebUI. Just enable the Deluge WebUI on your Slot Settings page. It can then be accessed via the link on your Manage page.

GTK+ "Thin Client"

The GTK+ user interface can be used as a thin client to connect with the daemon running on your Whatbox slot. It is a more reliable way to interact with Deluge.

  1. Download version 2.0+ and install Deluge.
  2. Run Deluge
  3. Go to "Edit -> Preferences -> Interface" and choose "Thin Client".
  4. Restart Deluge. You should now see a connection manager box pop up.
  5. Remove the localhost daemon.
  6. Click "Add" and enter your server next to hostname: server.whatbox.ca
  7. Enter the port your Deluge daemon is running on
    (The port can be found on your Slot Info page)
  8. Enter your username and slot password
  9. Click "Add" to add your server's daemon.
  10. Click "Connect" and the connection manager pop up box should disappear.

Congratulations! You can now access Deluge on your Whatbox slot via the GTK UI.

Tunnel the GTK+ Thin Client's Connection

All communication between the GTK UI and daemon is encrypted using an automatically generated self-signed certificate so SSH tunneling is not a requirement.

  1. Follow the instructions for setting up an SSH Tunnel
  2. Create a new forwarded port. For Windows users using KiTTY (or PuTTY), the source port will be your daemon's port (check the "Info" page to get your daemon port). The destination will be 127.0.0.2:##### where ##### is your daemon port again. Unlike the SSH Tunneling wiki article, you will set this to be a local port forward, not dynamic. Lastly, make sure that the "Local ports accept connections from other hosts checkbox" is checked.
  3. Create a new connection in the thin client's connection manager. The only difference in the above instructions for the GTK+ Thin Client is that you will enter 127.0.0.2 for the hostname rather than your server's hostname.
    You will need to have the SSH tunnel active if you wish to connect to your remote daemon.

Enable SSL (optional)

HTTPS for Deluge's WebUI can be enabled by heading to your Managed Links page

Console

The console user interface offers a convenient way to control Deluge over SSH. The deluge-console can be started by executing deluge-console through SSH.

For more information, take a look at the full Deluge console documentation.

Transdroid

Transdroid is an open-source application for managing torrents from Android devices. It is able to connect rTorrent, Deluge and Transmission.

For installation instructions and more information take a look at the main article.

Plugins

One attractive feature of Deluge is the ability to extend it with plugins. However, most deluge plugins are still prebuilt for Python 2.6 or 2.7. Deluge 2.0.5 running on a Whatbox server is running under Python 3.12. The net result is that plugins built for older versions of Python won't even show up in the list of installed plugins in Deluge settings.

Auto Remove Plus

This plugin can automatically 'clean up' torrents being seeded based on configurable criteria. For more information, see Plugin: Auto Remove Plus v2.0.0

As of writing, there isn't a prebuilt version for Python 3.12. Luckily it's not hard to build one.

You can find the source code at https://github.com/tote94/deluge-autoremoveplus.

First, make a local copy of the source code with the command:

    git clone https://github.com/tote94/deluge-autoremoveplus.git

This will create a directory called deluge-autoremoveplus containing the source code, so change your working directory to it by typing:

    cd deluge-autoremoveplus

Then comes the magic - type:

    python3 setup.py bdist_egg

and the plugin will be built. Once that's complete, type:

    cd dist && ls

You should see the plugin you just built - named something like AutoRemovePlus-2.0.0-py3.9.egg. To install this plugin, type:

    cp AutoRemovePlus-2* ~/.config/deluge/plugins

At this point, the AutoRemovePlus plugin should be visible in Deluge's Preferences dialog (assuming you're using the web UI), probably as the last item. Click on it, and configure to taste. By the way, time periods are specified in hours.

Note: since Whatbox is a shared platform, the 'remaining free space' as deluge sees it will always be very large and will not correspond to the free space remaining in your slot. In other words, leave this field set to -1. If you do not, your other rules will never be applied.

Configuration and log

All the interfaces should provide a way to change Deluge's settings. If you want, you can edit the core settings file. It is located at ~/.config/deluge/core.conf. Stop the "deluged" process before editing this file. Logs are also stored in this location.

YaRSS2

An RSS plugin for Deluge configured through the GTK client. Only usable through the GTK desktop client.

Download YaRSS2-2.1.5-py3.11.egg from here. Rename it to YaRSS2-2.1.5-py3.12.egg. Install via the plug-ins menu in the GTK desktop client. Deluge may need to be restarted afterwards for it to appear.

Performance tuning

Deluge defaults should work quite well even if you have many torrents and nodes. If you suspect your speed is lower than it should be, check the cache command on deluge-console: it will give you information such as the read_hit_ratio (the higher it is, the better: a value of 1 would mean you're always reading from memory, so that disk slowness doesn't affect your seeding).

The Deluge wiki has a page on bandwidth tweaking. Note it's mostly directed to ADSL users.