Last updated on 28 February 2024
Please note this guide was written for DSM7/7.1 and will not be updated for 7.2
| Update | Date |
|---|---|
| Fixed a regression with the port numbers both screenshots and wording. | 15/09/2023 |
What is Deluge?
Deluge is a lightweight torrent downloader, it has a number of built-in plugins to help organise your downloads and a full web interface.
Let’s Begin
In this guide I will take you through the steps to get Deluge up and running in Docker if you want to also run a VPN see my alternative guides on the left-hand menu.
In order for you to successfully use this guide please complete the three preceding guides
- Step 1: Directory Setup Guide
- Step 2: Setting up a restricted Docker user
- Step 3: Setting up a Docker Bridge Network
Downloading the Container
Open up Docker within DSM and navigate to the ‘Registry’ section and search for ‘deluge’ in the search box and download the ‘linuxserver/deluge’ image.
The pop-up box will ask which version you want to download, make sure you choose ‘Latest’ from the list of available versions.
You can check the status of the download over on the ‘Image’ tab.
Setting up the Container
In Docker click on the ‘Image’ tab, in the list of your containers select the ‘Linuxserver Deluge’ image and click on ‘Launch’
You will be greeted with the Network screen, we will be using the ‘synobridge’ network we created earlier select it from the list and click Next.
General Settings
Next you will be greeted with the General Settings screen, this is where you can start specifying some of your preferences.
You can change the name of the container to anything you like, and you may want to enable Auto Restart as this will ensure Deluge starts automatically if you reboot your NAS.
You will also notice a Configure capabilities button — don’t change anything in here!
Next up we are going to click on the ‘Advanced Settings’ button, this will take you to a new window with a number of tabs which we are going to work through.
Environment
Next we are going to set up some environment variables that docker will use to allow the container access to our files.
Fill in the following details as per the table/screenshot, you will need to do them one at a time.
| Variable | Value |
|---|---|
| PUID | The UID you obtained in the user setup guide |
| PGID | The GID you obtained in the user setup guide |
| TZ | Your timezone wikipedia.org/wiki/List_of_tz_database_time_zones |
Links/Execution Commands
You do not need to set up anything on these tabs.
Press ‘Save’ to go back to the initial setup screen, then press ‘Next’
Port Settings
We are not going to amend the default ports Deluge requires which are the following:
| Port | What it’s for… |
|---|---|
| 58846 (TCP) | Remote connection from a PC Client |
| 58946 (TCP & UDP) | Ports to forward on your Router to ensure you are connectable |
| 8112 (TCP) | WebUI |
Copy the ports shown on the Right hand ‘Container Port’ section to the left hand ‘Local Port’ section.
Once amended press ‘Next’
You can now click Next
Volume Settings
We will now be specifying the directories where Deluge will store its configuration files and where to download files to.
Click on Add Folder, click on the docker share and create a new sub-folder called ‘deluge’ select this folder and click ‘select’
Now add ‘/config’ to the ‘Mount path’ box
Click Add Folder again and this time select the ‘/data/torrents’ share and click Select.
You will now enter ‘/data/torrents’ into the ‘Mount path’ box
Your path settings should now look like the table/screenshot below.
| File/Folder | Mount path |
|---|---|
| docker/deluge | /config |
| data/torrents | /data/torrents |
Click Next to move to the final screen.
Click Next to move to the final screen.
Summary
You have now completed the setup of the container.
You will be shown an overall summary of the settings we have specified, this is a good time to double-check everything is correct. Finally, click on Done and the container should start to boot.
Finally, click on Done and the container should start to boot.
Setting up Deluge
As we have used /data/torrents as the mount point for our downloads we need to make sure Deluge uses this same file path.
We are going to do this by just changing the directory settings within Deluge.
Open a new browser tab and go to your NAS IP address on port 8112 (e.g. 192.168.0.46:8112)
Deluge by default has the password of deluge to access the web UI, you can change or remove this later in the settings.
Next you will connect to the Deluge back end, just select the host and click connect, it will remember this going forward.
Download Paths
Now you are in the UI click on Preferences at the top of the screen, we are going to change the various folders to the settings shown in the screenshot/table below
| Option | From | To |
|---|---|---|
| Download to: | /root/Downloads | /data/torrents/incoming |
| Move complete to: | /root/Downloads | /data/torrents/completed |
Port Number
You will also need to set the port number in the Incoming and Outgoing port sections in line with the ones we set up for the Container of 58946
Press apply and hit OK, your last task will be to port forward your router to you NAS the TCP and UDP ports of 58946 to ensure you get connected to other peers.
Plugins
There are a couple of plugins you will want to enable in the Plugins’ section in Preferences, when enabled you will need to refresh the page to see them. (If you are looking for something to unpack torrents that are zipped then follow the Unpackerr guide)
- Autoadd – This allows you to pull in any torrents in the watch directory (screenshot below)
- Label – This allows Radarr/Sonarr to assigned labels and pull downloads into subdirectories
- Auto Remove Plus – Download the ‘AutoRemovePlus-2.0.0-py3.8.egg’ version from the Deluge forums and place it in the Plugins’ folder in /docker/deluge/plugins. It allows you to fine tune when to remove torrents and their associated data once downloaded. (You may need to stop and and start the container for this to appear)
| Historic Updates | Date |
|---|---|
| New guide for Deluge | 13/09/2021 |
| Fixed port settings section and added notes around plug-ins | 30/12/2021 |
| Added an extra plugin and note on how to enable them | 06/03/2022 |
| Updated with DSM7.1 Screenshots and Steps | 09/07/2022 |
| Added new port settings and Docker Bridge Network | 23/07/2022 |
| Compose version number removed, small wording amendments and removed an old image. | 08/04/2023 |
| Amended the path to save the compose file – this is for security, so the container has no access to the file contents. | 14/04/2023 |
Buy Me a Coffee or a Beer
If you have found my site useful please consider pinging me a tip as it helps cover the cost of running things or just lets me get the odd beverage. Plus 10% goes to the devs of the apps I do guides for every year.
Hello,
I am also running into an issue logging in to deluge through the browser using any ports I have attempted. Do I need to set up the web station client? I am running DSM 7.2 and the only difference from your guide and what I implemented was that the setup was asking for an IP range while setting up the synobridge network – this could not be bypassed, the field would outline in red and not let me submit until I inputted values here. I have tried different values. I also have the NAS firewall running and followed your portion of the guide for that.
So no need for Webstation despite it harrasing you with the pop ups! See my updated versions of the guides for both Deluge and the Synobridge setup as they give you the correct options to use.
https://drfrankenstein.co.uk/step-3-setting-up-a-docker-bridge-network-in-container-manager/
https://drfrankenstein.co.uk/2023/04/26/deluge-with-gluetun-vpn-in-container-manager-on-a-synology-nas/
If you are running the firewall anything you set up in Docker will need an exception added for its ports otherwise the Firewall will block access. You do this by finding it in the list of ‘Applications’ in the Firewall settings or manually adding them.
Any advice on using the extractor plugin? I have the egg added but it doesn’t seem to do anything when a RAR archive is downloaded.
I don’t use Deluge day to day as moved to qbittorrent – Are you using the built-in plugin or a different one? I have unpackrrr on the list of guides coming up once I finish the DSM7.1 re-writes.
The built in one, I can hold on though. I have never heard of unpackrrr but it looks perfect for my use case. Thank you for the quick reply!
Have you experienced taht Deluge keep shutting down the client?
I can get into the web UI but i cant start the deamon.
I’ve followed your steps but when I go to my NAS IP + 8112, I get unable to connect but I can see files been created in docker/deluge
Hey, double check you have set the ports on both local and the container to 8112 and not accidentally left one set to Auto.
Thanks for replying, now I am getting local port conflict, even though in Router Configuration, none of those ports are setup
Do you have anything else using one of the ports? e.g 8112? You may need to set a slightly different external port (external being the external container port not anything to do with your router) and that will be the port you use to access deluge.
So you’re saying I don’t have to use 8112 or 6881? I also appreciate you actively responding! Ill definitely make a contribution
Ahh I think what you mean, can I make the container port any 4 numbers?
Thanks Doc! I’m all setup, learnt something new, thank you!
Good stuff, I would have come back sooner but I suspect we are in different time zones.
First time using docker on my Nas.
every step so far has gone smootly, but when i try to add the watch folder in AutoAdd i get the message “Path does not exist” /data/torrents/watch, even copyed pasted from file mannager to make sure i dont do a stupid typo. still got the wrong message.
tryed adding a torrent via radarr and the torrent got loaded in deluge with a error 100% in the download bar.
Hey, can you double-check you added the PUID and PGID the correct way around as that is usually the first thing to catch people out, and double-check your mount points.
Thx it was the wrong PUID.
Amazing guides btw.
Working through the ones that fits my needs.
We have all done it!