Official qbittorrent-nox docker image
Go to file
2022-12-10 14:30:20 +08:00
.github Import project 2022-12-10 14:30:20 +08:00
manual_build Import project 2022-12-10 14:30:20 +08:00
.env Import project 2022-12-10 14:30:20 +08:00
docker-compose.yml Import project 2022-12-10 14:30:20 +08:00
Dockerfile Import project 2022-12-10 14:30:20 +08:00
entrypoint.sh Import project 2022-12-10 14:30:20 +08:00
LICENSE Import project 2022-12-10 14:30:20 +08:00
Readme.md Import project 2022-12-10 14:30:20 +08:00

qBittorrent-nox Docker Image GitHub Actions CI Status

Repository on Docker Hub: https://hub.docker.com/repository/docker/qbittorrentofficial/qbittorrent-nox
Repository on GitHub: https://github.com/qbittorrent/docker-qbittorrent-nox

Supported architectures

  • linux/amd64
  • linux/arm/v6
  • linux/arm/v7
  • linux/arm64/v8

Reporting bugs

If the problem is related to Docker, please report it to this repository:
https://github.com/qbittorrent/docker-qbittorrent-nox/issues

If the problem is with qBittorrent, please report the issue to its main repository:
https://github.com/qbittorrent/qBittorrent/issues

Usage

  1. Prerequisites

    In order to 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/

  2. Download this repository

    You can either git clone this repository or download an .zip of it: https://github.com/qbittorrent/docker-qbittorrent-nox/archive/refs/heads/main.zip

  3. Edit Docker environment file

    If you are not using Docker Compose you can skip editing the environment file. However the variables presented below is crucial in later steps, make sure you understand them.

    Find and open the .env file in the repository you cloned (or the .zip archive you downloaded).
    There are a few variables that you must take care of before you can run the image.
    You can find the meanings of these variables in the following section. Make sure you understand every one of them.

    Environment variables

    • QBT_EULA
      This environment variable defines whether you accept the end-user license agreement (EULA) of qBittorrent.
      Put accept only if you understand and accepted the EULA. You can find the EULA here.
    • QBT_VERSION
      This environment variable specifies the version of qBittorrent-nox to use.
      For example, 4.4.5-1 is a valid entry. You can find all tagged versions here.
      Or you can put latest to use the latest stable release of qBittorrent.
    • QBT_WEBUI_PORT
      This environment variable sets the port number which qBittorrent WebUI will be binded to.

    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.
  4. Running the image

    • If using Docker (not Docker Compose), edit the variables run:

      export \
        QBT_EULA=<put_accept_here> \
        QBT_VERSION=latest \
        QBT_WEBUI_PORT=8080 \
        QBT_CONFIG_PATH="<your_path>/config"
        QBT_DOWNLOADS_PATH="<your_path>/downloads"
      docker run \
        -t \
        --read-only \
        --rm \
        --tmpfs /tmp \
        --name qbittorrent-nox \
        -e QBT_EULA \
        -e QBT_WEBUI_PORT \
        -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 \
        qbittorrentofficial/qbittorrent-nox:${QBT_VERSION}
      
    • If using Docker Compose:

      docker compose up
      
    • Then you can login to qBittorrent-nox at: http://127.0.0.1:8080
      Don't forget to change the default login password to something else!
      You can change it at 'Tools' menu -> 'Options...' -> 'Web UI' tab -> 'Authentication'.

  5. Stopping container

    • When using Docker (not Docker Compose):

      docker stop -t 1800 qbittorrent-nox
      
    • When using Docker Compose:

      docker compose down
      

Build image manually

Refer to manual_build folder.