docker-qbittorrent-nox/manual_build

Manually Build qBittorrent-nox Docker Image

This Dockerfile allows you to build a Docker Image containing qBittorrent-nox

Prerequisites

In order to build/run this image you'll need Docker installed: https://docs.docker.com/get-docker/

If you don't need the GUI, you can just install Docker Engine: https://docs.docker.com/engine/install/

It is also recommended to install Docker Compose as it can significantly ease the process: https://docs.docker.com/compose/install/

Building Docker Image

• If you are using Docker (not Docker Compose) then run the following commands in this folder:

  export \
    QBT_VERSION=devel
  docker build \
    --build-arg QBT_VERSION \
    -t qbittorrent-nox:"$QBT_VERSION" \
    .
  

• If you are using Docker Compose then you should edit .env file first. You can find an explanation of the variables in the following Parameters section.
  Then run the following commands in this folder:

  docker compose build \
    --build-arg QBT_VERSION
  

Parameters

Environment variables

• QBT_LEGAL_NOTICE
  This environment variable defines whether you had read the legal notice of qBittorrent.
  Put confirm only if you had read the legal notice. You can find the legal notice here.
• QBT_VERSION
  This environment variable specifies the version of qBittorrent-nox to be built.
  For example, 4.4.0 is a valid entry. You can find all tagged versions here.
  You can put devel to build the latest development version.
• QBT_WEBUI_PORT
  This environment variable sets the port number which qBittorrent WebUI will be binded to. Defaults to port 8080 if value is not set.

Volumes

There are some paths involved:

• <your_path>/config
  Full path to a folder on your host machine which will store qBittorrent configurations. Using relative path won't work.
• <your_path>/downloads
  Full path to a folder on your host machine which will store the files downloaded by qBittorrent. Using relative path won't work.

Running container

• Using Docker (not Docker Compose), simply run:

  export \
    QBT_LEGAL_NOTICE=<put_confirm_here> \
    QBT_VERSION=devel \
    QBT_WEBUI_PORT=8080 \
    QBT_CONFIG_PATH="<your_path>/config" \
    QBT_DOWNLOADS_PATH="<your_path>/downloads"
  docker run \
    -t \
    --name qbittorrent-nox \
    --read-only \
    --rm \
    --stop-timeout 1800 \
    --tmpfs /tmp \
    -e QBT_LEGAL_NOTICE \
    -e QBT_WEBUI_PORT \
    -e TZ=UTC \
    -p "$QBT_WEBUI_PORT":"$QBT_WEBUI_PORT"/tcp \
    -p 6881:6881/tcp \
    -p 6881:6881/udp \
    -v "$QBT_CONFIG_PATH":/config \
    -v "$QBT_DOWNLOADS_PATH":/downloads \
    qbittorrent-nox:"$QBT_VERSION"
  

• Using Docker Compose:

  docker compose up
  

• A few notes:

  • By default the timezone in the container uses the default of Alpine Linux (which is most likely UTC). You can set the environment variable TZ to your preferred value.
  • You can change the User ID (UID) and Group ID (GID) of the qbittorrent-nox process by setting environment variables PUID and PGID respectively. By default they are both set to 1000.
    Note that you will need to remove --read-only flag (when using Docker) or set read_only: false (when using Docker Compose) as they are incompatible with it.
  • You can set additional group ID (AGID) of the qbittorrent-nox process by setting the environment variable PAGID. For example: 10000,10001, this will set the process to be in two (secondary) groups 10000 and 10001. By default there is no additional group.
    Note that you will need to remove --read-only flag (when using Docker) or set read_only: false (when using Docker Compose) as they are incompatible with it.
  • It is possible to set the umask of the qbittorrent-nox process by setting the environment variable UMASK. By default it uses the default from Alpine Linux.
  • You can list the compile-time Software Bill of Materials (sbom) with the following command:

    docker run --entrypoint /bin/cat --rm qbittorrentofficial/qbittorrent-nox:latest /sbom.txt
    

• Then you can login to qBittorrent-nox at: http://<your_docker_host_address>:8080

  • For older qBittorrent versions (< 4.6.1), the default username/password is: admin/adminadmin.
  • For newer qBittorrent versions (≥ 4.6.1), qBittorrent will generate a temporary password and print it to the console (via stdout). You need to use it to login. See the announcement.
    If you don't have a console attached, you can run docker logs qbittorrent-nox to show the logs.

  After logging in, don't forget to change the password to something else!
  To change it in WebUI: 'Tools' menu -> 'Options...' -> 'Web UI' tab -> 'Authentication'

Stopping container

• Using Docker (not Docker Compose):

  docker stop qbittorrent-nox
  

• Using Docker Compose:

  docker compose down