2019-10-02 03:56:43 +00:00
# [linuxserver/qbittorrent](https://github.com/linuxserver/docker-qbittorrent)
2019-02-06 04:56:27 +00:00
2019-11-01 01:07:30 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-qbittorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-qbittorrent)
[![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-qbittorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-qbittorrent/releases)
[![GitHub Package Repository ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-qbittorrent/packages)
[![GitLab Container Registry ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF )](https://gitlab.com/Linuxserver.io/docker-qbittorrent/container_registry)
[![Quay.io ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/qbittorrent)
2019-10-02 03:56:43 +00:00
[![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/qbittorrent.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/qbittorrent "Get your own version badge on microbadger.com")
2019-11-01 01:07:30 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/qbittorrent.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/qbittorrent)
[![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/qbittorrent.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/qbittorrent)
2019-10-02 03:56:43 +00:00
[![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/)
[![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/index.html)
2019-02-06 04:56:27 +00:00
The [Qbittorrent ](https://www.qbittorrent.org/ ) project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
## Supported Architectures
2019-09-04 03:55:52 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-06 04:56:27 +00:00
2019-02-13 04:55:44 +00:00
Simply pulling `linuxserver/qbittorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-06 04:56:27 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-10-02 03:56:43 +00:00
| :----: | --- |
2019-02-06 04:56:27 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 20:22:45 +00:00
| armhf | arm32v7-latest |
2019-02-06 04:56:27 +00:00
2019-11-05 16:41:19 +00:00
## Version Tags
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
| :----: | --- |
| latest | Stable qbittorrent releases |
| unstable | Unstable qbittorrent releases |
2019-10-02 03:56:43 +00:00
2019-02-06 04:56:27 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-02 03:56:43 +00:00
```
2019-02-06 04:56:27 +00:00
docker create \
--name=qbittorrent \
2019-03-06 04:55:51 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-06 04:56:27 +00:00
-e TZ=Europe/London \
-e UMASK_SET=022 \
-e WEBUI_PORT=8080 \
-p 6881:6881 \
-p 6881:6881/udp \
-p 8080:8080 \
-v < /path/to/appdata/config>:/config \
2019-03-25 14:23:04 +00:00
-v < /path/to/downloads>:/downloads \
2019-02-06 04:56:27 +00:00
--restart unless-stopped \
linuxserver/qbittorrent
```
2019-10-02 03:56:43 +00:00
2019-02-06 04:56:27 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
qbittorrent:
image: linuxserver/qbittorrent
container_name: qbittorrent
environment:
2019-03-06 04:55:51 +00:00
- PUID=1000
- PGID=1000
2019-02-06 04:56:27 +00:00
- TZ=Europe/London
- UMASK_SET=022
- WEBUI_PORT=8080
volumes:
- < /path/to/appdata/config>:/config
2019-03-25 14:23:04 +00:00
- < /path/to/downloads>:/downloads
2019-02-06 04:56:27 +00:00
ports:
- 6881:6881
- 6881:6881/udp
- 8080:8080
restart: unless-stopped
```
## Parameters
2019-10-02 03:56:43 +00:00
Docker images 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.
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
### Ports (`-p`)
2019-02-06 04:56:27 +00:00
| Parameter | Function |
2019-10-02 03:56:43 +00:00
| :----: | --- |
2019-02-06 04:56:27 +00:00
| `6881` | tcp connection port |
| `6881/udp` | udp connection port |
| `8080` | http gui |
2019-10-02 03:56:43 +00:00
### Environment Variables (`-e`)
2019-02-06 04:56:27 +00:00
| Env | Function |
2019-10-02 03:56:43 +00:00
| :----: | --- |
2019-03-06 04:55:51 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-06 04:56:27 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `UMASK_SET=022` | for umask setting of qbittorrent, optional , default if left unset is 022 |
| `WEBUI_PORT=8080` | for changing the port of the webui, see below for explanation |
2019-10-02 03:56:43 +00:00
### Volume Mappings (`-v`)
2019-02-06 04:56:27 +00:00
| Volume | Function |
2019-10-02 03:56:43 +00:00
| :----: | --- |
2019-02-06 04:56:27 +00:00
| `/config` | Contains all relevant configuration files. |
2019-03-25 14:23:04 +00:00
| `/downloads` | Location of downloads on disk. |
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
2019-02-06 04:56:27 +00:00
## User / Group Identifiers
2019-10-02 03:56:43 +00:00
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` .
2019-02-06 04:56:27 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-06 04:55:51 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
```
2019-02-06 04:56:27 +00:00
$ id username
2019-03-06 04:55:51 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-06 04:56:27 +00:00
```
## Application Setup
2019-10-02 03:56:43 +00:00
The webui is at `<your-ip>:8080` and the default username/password is `admin/adminadmin` .
Change username/password via the webui in the webui section of settings.
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
### WEBUI_PORT variable
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port.
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
This should alleviate the "white screen" issue.
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
If you have no webui , check the file /config/qBittorrent/qBittorrent.conf
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
edit or add the following lines
2019-02-06 04:56:27 +00:00
2019-10-02 03:56:43 +00:00
```
2019-02-06 04:56:27 +00:00
WebUI\Address=*
WebUI\ServerDomains=*
```
2019-10-02 03:56:43 +00:00
2019-02-06 04:56:27 +00:00
## Support Info
2019-09-04 03:55:52 +00:00
* Shell access whilst the container is running:
2019-02-06 04:56:27 +00:00
* `docker exec -it qbittorrent /bin/bash`
2019-09-04 03:55:52 +00:00
* To monitor the logs of the container in realtime:
2019-02-06 04:56:27 +00:00
* `docker logs -f qbittorrent`
2019-09-04 03:55:52 +00:00
* Container version number
2019-02-06 04:56:27 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/qbittorrent`
## Versions
2020-04-05 21:47:15 +00:00
* **03.04.20:** - Fix adding search engine plugin
2019-08-03 03:59:25 +00:00
* **02.08.19:** - Add qbitorrent-cli for processing scripts.
2019-03-24 20:22:45 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-06 04:56:27 +00:00
* **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.
2019-10-02 03:56:43 +00:00
* **02.01.18:** - Deprecate cpu_core routine lack of scaling.
2019-02-06 04:56:27 +00:00
* **19.12.17:** - Update to v4.0.3.
* **09.02.17:** - Rebase to alpine 3.7
* **01.12.17:** - Update to v4.0.2.
2019-10-02 03:56:43 +00:00
* **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.
2019-02-06 04:56:27 +00:00
* **01.08.17:** - Initial Release.
* **12.02.18:** - Initial Release.