Fork of mogeko's image since it hasn't been maintained in a few years

Find a file

dependabot[bot] 370ac9f8ae build(deps): bump actions/upload-artifact from 2 to 3 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2 to 3. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>		2022-04-08 20:26:11 +00:00
.devcontainer	build: set up Makefile	2021-11-18 00:14:34 +00:00
.github	build(deps): bump actions/upload-artifact from 2 to 3	2022-04-08 20:26:11 +00:00
example	feat: compile libtorrent locally	2021-11-18 15:28:31 +00:00
root	feat: run qbittorrent-nox with a script	2021-11-16 18:37:29 +00:00
.gitattributes	build: exclude .devcontainer/*from git language statistics	2021-11-16 19:35:43 +00:00
.gitignore	feat: update qbittorrent to 4.3.9	2021-11-19 16:40:21 +00:00
Dockerfile	feat: compile file with ninja	2021-11-20 20:40:32 +00:00
latest.json	fix: use DCMAKE_C_COMPILER to set c compiler for cmake	2021-11-20 10:49:29 +00:00
LICENSE	Initial commit	2021-11-11 18:52:08 +01:00
Makefile	build: store version data with latest.json	2021-11-18 16:59:00 +00:00
README.md	docs(readme): update badges	2021-11-20 20:55:02 +00:00

README.md

docker-qbittorrent

Docker image for qBittorrent.

Tiny size
Enable rootless¹
Enable QBT_* options²
Keep updating
Compile by clang

Usage

Pull this image:

docker pull ghcr.io/mogeko/qbittorrent

Run with docker cli:

docker run -d \
  --name qbittorrent \
  --user 1000:100 `#optional` \
  -e QBT_WEBUI_PORT=8080 \
  -p 6881:6881 \
  -p 6881:6881/udp \
  -p 8080:8080 \
  -v /path/to/config:/config \
  -v /path/to/downloads:/downloads \
  --restart unless-stopped \
  ghcr.io/mogeko/qbittorrent

Run with docker-compose:

---
version: 2.1
services:
  qbittorrent:
    image: ghcr.io/mogeko/qbittorrent
    container_name: qbittorrent
    user: 1000:100 #optional
    environment:
      - QBT_WEBUI_PORT=8080
    volumes:
      - /path/to/config:/config
      - /path/to/downloads:/downloads
    ports:
      - 6881:6881
      - 6881:6881/udp
      - 8080:8080
    restart: unless-stopped

Parameters

Container 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.

Parameter	Function
`-p 6881`	tcp connection port
`-p 6881/udp`	udp connection port
`-p 8080`	The Web UI port
`-e QBT_WEBUI_PORT=8080`	Change the Web UI port
`-v /config`	Save the configuration files
`-v /downloads`	Location of downloads on disk

The qbittorrent-nox's options may be supplied via environment variables². For option named 'parameter-name', environment variable name is QBT_PARAMETER_NAME (in uppercase, - replaced with _). To pass flag values, set the variable to 1 or TRUE. Here is an example we already in used: -e QBT_WEBUI_PORT=8080.

More help message about qbittorrent-nox, you can get via:

docker run -it ghcr.io/mogeko/qbittorrent --help

License

The code in this project is released under the GPL-3.0 License.

This image should be able to work with podman, but it has not been tested. ↩︎
The option QBT_PROFILE does not support. ↩︎