Deluge
Deluge is a fully-featured, high performance cross-platform BitTorrent client.
Initial Setup
First you must connect to your slot via ssh. If you need help connecting to the server, please read the help article here.
Installing Deluge is easy. Simply issue the following command:
box install deluge
This command will configure Deluge and the associated web interface "Deluge-Web" for use with your slot.
How to Access
Thin Client (recommended)
The GTK thin client uses a secure connection to your slot to display the remote contents in the local client. Generally speaking, the thin client is capable of handling more torrents and simply offers better performance than the alternative Web UI. However, in order to use the Thin client, you must have a version of Deluge installed locally on the computer you wish to access your remote client from. Thus the argument of Thin vs Web is generally a choice between "Performance" and "Convenience". Further, the Thin client supports a broader range of plugins -- many plugins have no interface for the Web UI at all.
In order to use the Thin client, you must have a recent version of Deluge installed locally on your computer. Below are instructions for popular operating systems:
panel
Grab the most recent version from here and save it to a common location (i.e. Downloads).
Run the installer and follow the prompts.
panel
Deluge is available from the distribution repositories. Simply open a terminal and issue the command:
sudo apt update
sudo apt install deluge
panel
Deluge is available from the distribution repositories. Simply open a terminal and issue the command:
sudo zypper install deluge
panel
Deluge is available from the distribution repositories. Simply open a terminal and issue the command:
sudo dnf install deluge
panel
Deluge is available from the distribution repositories. Simply open a terminal and issue the command:
sudo pacman -S deluge
Now that Deluge is installed on your machine, you need to configure it to connect to your slot.
First, we must prevent Deluge from starting in "Classic" mode. To do this, open Deluge. In the menu, go to Preferences > Interface and untick the box which states "Classic Mode".
Deluge will prompt you to restart. Click "Ok" and re-open Deluge.
You'll notice when you re-open the application that a new connection dialog box will open. Hit the "Add" button and use the following details:
Hostname: <the hostname of your server>
Username: <your username>
Password: <your password>
Port: <the daemon port of your instance>
note
During the configuration of Deluge on your slot, the setup output both your Daemon and Web ports. If you've forgotten your daemon port, you can find it with the following command:
cat ~/.config/deluge/core.conf | grep daemon_port
Once you click okay, you'll be taken back to the connection dialog. Your new connection will be listed and if everything is okay, you'll see a green check box next to it. When you click connect, you'll be taken to your client.
Web UI
The web UI is significantly easier to access, which is why many prefer it. You can access deluge-web from https://yourhost.ltd/deluge.
If you are not currently logged in, you will first receive a basic authentication dialog from the webserver. Once authenticated, you'll receive a dialog box from Deluge-Web. This password is the same as the one you just entered.
note
This second password authetication layer cannot be fully removed due to restrictions in Deluge. However, you can increase the length of time that the cookie is stored locally by your browser to one year (from one hour):
box stop deluge-web
sed -i 's/"session_timeout": 3600,/"session_timeout": 31536000,/g' ~/.config/deluge/web.conf
box start deluge-web
deluge-console
Getting Started
You can access the command line version of the deluge console by using the command:
deluge-console
Connecting to Your Daemon
Once loaded, you'll need to specify your daemon port to connect to:
connect 127.0.0.1:<daemon port>
Available Commands
Once you have successfully connected to the daemon, you can get started with the following commands:
>>> help
add - Add a torrent
cache - Show information about the disk cache
config - Show and set configuration values
connect - Connect to a new deluge server.
debug - Enable and disable debugging
del - Remove a torrent
exit - Exit from the client.
halt - Shutdown the deluge server.
help - displays help on other commands
info - Show information about the torrents
pause - Pause a torrent
plugin - Manage plugins with this command
quit - Exit from the client.
reannounce - Update tracker for torrent(s)
recheck - Forces a recheck of the torrent data
resume - Resume a torrent
rm - Remove a torrent
update-tracker - Update tracker for torrent(s)
For help on a specific command, use "<command> --help"
Service Management
Like all box configured applications, you can manage Deluge via SSH with box with start, stop, restart, enable and disable commands. To restart the deluge daemon, use deluged. To restart the web interface use deluge-web
box start deluged
box stop deluged
box restart deluged
box enable deluged
box disable deluged
Configuration
Most of the settings in the preferences should be left alone; however, you're welcome to alter settings such as Download location. That said, you should leave the majority of Connection Settings and ltConfig settings alone, as the settings have already been optimized for use on your slot.
Plugins
There are a wide array of plugins available for Deluge. You can find a list of them in the Deluge wiki, here.
note
Not all plugins have a web-ui component. You will likely need to install and manage the options for most of the plugins on the prior page with the thin client.
Connect to other clients
The following variables can be used as a general guide to help you find information you'll need to know in order to connect other clients to Deluge.
- Host:
127.0.0.1 - Daemon port:
cat ~/.config/deluge/core.conf | grep daemon_port - Web port:
cat ~/.config/deluge/web.conf | grep port - URL base:
/deluge(only if accessing viahttps)
Connecting to a remote client (i.e. Sonarr)
By default, the web interface of Deluge is bound to 127.0.0.1. In other words, the interface isn't directly accessible from a remote connection. If you want to connect Deluge-web to a remote instance of an application (for instance, Sonarr running from home), you'll need to enable remote connections.
SSH into your slot and issue the following commands:
box stop deluge-web
sed -i 's/127.0.0.1/0.0.0.0/g' ~/.config/deluge/web.conf
box start deluge-web
You can now connect to your Deluge-web instance through http://hostname.ltd:<delugeport>