Important or Recent Updates
|Fresh new guide by popular demand||28/09/2023|
|Updated with new steps to obtain and change WebUI password||21/11/2023|
|Issue with passwords has been fixed in 4.6.2 so removed tty line from yaml||29/11/2023|
What is qBittorrent?
qBittorrent is a torrent downloader used to both manage torrent downloading and seeding.
If you are looking to combine a VPN with this set up see the GlueTUN guide on the left Menu
In this guide I will take you through the steps to get qBittorrent up and running in Docker
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
Let’s start by getting some folders set up for the containers to use. Open up File Station create the following.
Next we are going to set up a ‘Project’ in Container Manager, a project is used when you want one or more to all be loaded together and uses Docker Compose to do this.
Open up Container Manager and click on Project then on the right-hand side click ‘Create’
In the next screen we will set up our General Settings, enter the following:
Next we are going to drop in our docker compose configuration copy all the code in the box below and paste it into line ‘1’ just like the screenshot
services: qbittorrent: image: linuxserver/qbittorrent:latest container_name: qbittorrent environment: - PUID=1234 #CHANGE_TO_YOUR_UID - PGID=65432 #CHANGE_TO_YOUR_GID - TZ=Europe/London #CHANGE_TO_YOUR_TZ - WEBUI_PORT=8090 volumes: - /volume1/docker/qbittorrent:/config - /volume1/data/torrents:/data/torrents ports: - 9854:9854/tcp # Forwarded Port on Router TCP - 9854:9854/udp # Forwarded Port on Router TCP - 8090:8090 # port for qbittorrent webui network_mode: synobridge restart: always
We are now going to amend some key variables to make sure the container has access to our folders and also knows where we are in the world. Don’t change any other settings other than those I mention.
|PUID||(required) The UID you obtained in the user setup guide|
|PGID||(required) The GID you obtained in the user setup guide|
|TZ||(required) Your timezone wikipedia.org/wiki/List_of_tz_database_time_zones|
Nothing to change here, the webui will run on port 8090 and the ports we will be using for the torrent protocol will be 9854 for TCP and UDP.
By default, I have assumed you have your config files stored on /volume1 if these are located on another volume amend this line accordingly.
You do not need to enable anything on the ‘Web portal settings’ screen click ‘Next’ again
On the final screen click Done which will begin the download of the container images and once downloaded they will be launched!
The images will now be downloaded and extracted. You should see ‘Code 0’ when it has finished.
You will now see your qbit-project running with a green status on the left-hand side.
(Skip if you don’t have the Firewall configured)
If you have enabled and configured the Synology Firewall you will need to create exceptions for any containers that have a Web UI or have any incoming or outgoing connections. This section covers the basics of how to add these. (Please note this is a generic section and will not show the specific ports in this guide however it applies in the same way)
Head into the
Firewall, from here click
Edit Rules for the profile you set up when you enabled the Firewall.
Next click on
Create and you will see the screen below. Source IP and Action will be automatically selected to All and Allow, I will leave it up to you as to your own preference on whether you want to lock down specific Source IPs from having access. In this example we will leave as All.
You will now choose ‘Select from a list of built-in applications‘ and then the
Now from the list choose the newly created Docker container (You can do more than one if you wish)
Click OK a couple of times to get back to the main screen. You will see by default the new rule is added to the bottom of the list. You must always have your Block All rule last in the list as the rules are applied top down so move your container up.
You have now completed the Firewall changes and can continue with the guide.
Changing the default WebUI login and password
If you skip this step you won’t be able to log in.
Now the container has started open it in the Docker UI and go to the Log tab. Within the logs you will see the login details
Now before doing any more of the guide go to the Web UI by going to the IP of your NAS followed by port 8090 and log in. Then on the WebUI tab change the defaults to your own and save them.
Now continue on..
Router Port Forwarding
As you can imagine there are thousands of possible router configs out there, so you will need to check the manual for your own.
Essentially you need to Port Forward port 9854 TCP and UDP to your NAS IP address. This will make you connectable for all peers. Most routers support UPnP or NAT-PNP which will automatically set up ports however it’s usually more secure to turn these off and do it manually.
Final qBittorrent steps
As we have used /data/torrents as the mount point for our downloads we need to make sure qBittorrent uses this same file path.
We need to change the file paths by editing the qBittorrent config file, before doing this stop both of the containers. Do this by selecting the Project from the main UI and under Action selecting ‘Stop’.
You can edit this file in a number of ways, but to keep the guide OS-agnostic we will be using the Synology Text Editor package which can be installed via Package Center.
Open Text Editor and browse to /docker/qbittorrent/qbittorrent and open the qBittorrent.conf then edit the file in line with the table below, once amended save the changes.
|Original Value||New Value|
You can now bring the containers back up again by starting the Project.
Once the containers are running you can log into the Web UI by going to the IP of your NAS followed by port 8090
Log in with the username and password you created earlier.
Now you are in the UI click on settings cog at the top of the screen, we are going to change one more directory which is the watched folder to /data/torrents/watch. You can also turn on the option ‘keep incomplete torrents in:’ which should already have /data/torrents/incoming’ prefilled.
Next we are going to set a command to run when each torrent finishes to automatically extract any .rar files (Note if you have any issues with this I would recommend using Unpackerr the guide is on the menu)
Scroll down in the options to the ‘Run external program on torrent completion’ and enter the below, it tells qbittorrent to run unrar and extract the file to the same save path as the original file. This will not delete anything, so you can continue seeding.
unrar x "%D/*.r*" "%D/"
The last step is to tell qBittorrent to use the correct port for communication enter 9854 in the Listening Port.
I am not going to walk through all the other settings as you can customise these as you wish.
More will be added as questions come up
Buy Me a Coffee or Throw me some Sats
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.