linuxserver/qbittorrent

https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png]([***]

The LinuxServer.io team brings you another container release featuring:

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• Blog - all the things you can do with our containers including How-To guides, opinions and much more!
• *** - realtime support / chat with the community and the team.
• Discourse - post on our community forum.
• https://github.com/linuxserver - view the source for all of our repositories.
• Open Collective - please *** helping us by either donating or contributing to our budget

https://github.com/linuxserver/docker-qbittorrent

![Scarf.io pulls]([] ![GitLab Container Registry]([] ![Quay.io]([] ![Jenkins Build]([] ![LSIO CI]([***]

The Qbittorrent is a bittorrent client programmed in C++ / Qt that uses libtorrent (sometimes called libtorrent-rasterbar) by Arvid Norberg.

https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/qbittorrent-icon.png]([***]

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list and our announcement here.

Simply pulling lscr.io/linuxserver/qbittorrent:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Application Setup

The web UI is at <your-ip>:8080 and a temporary password for the admin user will be printed to the container log on startup.

You must then change username/password in the web UI section of settings. If you do not change the password a new one will be generated every time the container starts.

If you are running a very old (3.x) kernel you may run into https://github.com/linuxserver/docker-qbittorrent/issues/103 which can be worked around using https://github.com/linuxserver/docker-qbittorrent/issues/103#issuecomment-831238484

WEBUI_PORT variable

Due to issues with CSRF and port mapping, should you require to alter the port for the web UI you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port.

For example, to set the port to 8123 you need to set -p 8123:8123 and -e WEBUI_PORT=8123

TORRENTING_PORT

A bittorrent client can be an active or a passive node. Running your client as an active node has the advantage of being able to connect to both active and passive peers, and can potentially increase the number of incoming connections. This requires an open port on the host machine which might differ from container's internal one.

Similarly to the WEBUI_PORT, to set the port to 6887 you need to pass -p 6887:6887, -p 6887:6887/udp and -e TORRENTING_PORT=6887 arguments to Docker.

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

[!NOTE] Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

yaml
---
services:
  qbittorrent:
    image: lscr.io/linuxserver/qbittorrent:latest
    container_name: qbittorrent
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - WEBUI_PORT=8080
      - TORRENTING_PORT=6881
    volumes:
      - /path/to/qbittorrent/appdata:/config
      - /path/to/downloads:/downloads #optional
    ports:
      - 8080:8080
      - 6881:6881
      - 6881:6881/udp
    stop_grace_period: "10s" #optional
    restart: unless-stopped

docker cli (click here for more info)

bash
docker run -d \
  --name=qbittorrent \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WEBUI_PORT=8080 \
  -e TORRENTING_PORT=6881 \
  -p 8080:8080 \
  -p 6881:6881 \
  -p 6881:6881/udp \
  -v /path/to/qbittorrent/appdata:/config \
  -v /path/to/downloads:/downloads `#optional` \
  --stop-timeout="10s" `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/qbittorrent:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

bash
id your_user

Example output:

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various https://github.com/linuxserver/docker-mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:

  bash
  docker exec -it qbittorrent /bin/bash
  

• To monitor the logs of the container in realtime:

  bash
  docker logs -f qbittorrent
  

• Container version number:

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent
  

• Image version number:

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qbittorrent:latest
  

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update images:

  • All images:

    bash
    docker-compose pull
    

  • Single image:

    bash
    docker-compose pull qbittorrent
    

• Update containers:

  • All containers:

    bash
    docker-compose up -d
    

  • Single container:

    bash
    docker-compose up -d qbittorrent
    

• You can also remove the old dangling images:

  bash
  docker image prune
  

Via Docker Run

• Update the image:

  bash
  docker pull lscr.io/linuxserver/qbittorrent:latest
  

• Stop the running container:

  bash
  docker stop qbittorrent
  

• Delete the container:

  bash
  docker rm qbittorrent
  

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  bash
  docker image prune
  

Image Update Notifications - Diun (Docker Image Update Notifier)

[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

bash
git clone https://github.com/linuxserver/docker-qbittorrent.git
cd docker-qbittorrent
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/qbittorrent:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 04.05.26: - Switch to static builds for parity with libtorrentv1 branch. Rebase to Alpine 3.23.
• 17.07.24: - Restore qbittorrent-cli as it now supports openssl 3.
• 25.05.24: - Remove qbittorrent-cli as it still requires openssl 1.1 which is EOL.
• 14.02.24: - Only set/override torrenting port if the optional env var is set.
• 14.02.24: - Add torrenting port support.
• 31.01.24: - Remove obsolete compat packages.
• 25.12.23: - Only pull stable releases of qbittorrent-cli.
• 07.10.23: - Install unrar from https://github.com/linuxserver/docker-unrar.
• 10.08.23: - Bump unrar to 6.2.10.
• 17.06.23: - Deprecate armhf as per [***]
• 10.06.23: - Bump unrar to 6.2.8.
• 23.02.23: - Add qt6-qtbase-sqlite to support SQLite database for resume files.
• 29.11.22: - Add openssl1.1-compat for qbittorrent-cli.
• 31.10.22: - Add libtorrentv1 branch.
• 31.08.22: - Rebase to Alpine Edge again to follow latest releases.
• 12.08.22: - Bump unrar to 6.1.7.
• 16.06.22: - Rebase to Alpine 3.16 from edge.
• 25.05.22: - Fetch qbitorrent-cli from upstream repo.
• 02.03.22: - Add unrar, 7zip, and qbitorrent-cli.
• 01.03.22: - Add python for search plugin support.
• 23.02.22: - Rebase to Alpine Edge, install from Alpine repos.
• 19.02.22: - Add jq to build-stage
• 07.01.22: - Rebase to Alpine, build from source.
• 06.01.22: - Deprecate unstable branch.
• 10.02.21: - Rebase to focal.
• 20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
• 12.11.20: - Stop creating /config/data directory on startup
• 03.04.20: - Fix adding search engine plugin
• 02.08.19: - Add qbitorrent-cli for processing scripts.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 14.01.19: - Rebase to Ubuntu, add multi arch and pipeline logic.
• 25.09.18: - Use buildstage type build, bump qbitorrent to 4.1.3.
• 14.08.18: - Rebase to alpine 3.8, bump libtorrent to 1.1.9 and qbitorrent to 4.1.2.
• 08.06.18: - Bump qbitorrent to 4.1.1.
• 26.04.18: - Bump libtorrent to 1.1.7.
• 02.03.18: - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6.
• 02.01.18: - Deprecate cpu_core routine lack of scaling.
• 19.12.17: - Update to v4.0.3.
• 09.02.17: - Rebase to alpine 3.7
• 01.12.17: - Update to v4.0.2.
• 27.11.17: - Update to v4 and use cpu_core routine to speed up builds.
• 16.09.17: - Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui.
• 01.08.17: - Initial Release.
• 12.02.18: - Initial Release.