An open API service indexing awesome lists of open source software.

https://github.com/daemonless/qbittorrent

Fast, stable BitTorrent client with a feature-rich web UI. Native FreeBSD OCI image for Daemonless.
https://github.com/daemonless/qbittorrent

container daemonless downloader freebsd ocijail podman qbittorrent torrent

Last synced: 12 days ago
JSON representation

Fast, stable BitTorrent client with a feature-rich web UI. Native FreeBSD OCI image for Daemonless.

Awesome Lists containing this project

README

          

# qBittorrent

[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/qbittorrent/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/qbittorrent/actions)
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/qbittorrent?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/qbittorrent/commits)

Fast, stable BitTorrent client with a feature-rich web UI. Supports DHT, PEX, encryption, magnet links, RSS, IP filtering, and remote management.

| | |
|---|---|
| **Port** | 8080 |
| **Registry** | `ghcr.io/daemonless/qbittorrent` |
| **Source** | [https://github.com/qbittorrent/qBittorrent](https://github.com/qbittorrent/qBittorrent) |
| **Website** | [https://www.qbittorrent.org/](https://www.qbittorrent.org/) |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` / `pkg` | **FreeBSD Quarterly**. Uses stable, tested packages. | Most users. Matches Linux Docker behavior. |
| `pkg-latest` | **FreeBSD Latest**. Rolling package updates. | Newest FreeBSD packages. |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
qbittorrent:
image: ghcr.io/daemonless/qbittorrent:latest
container_name: qbittorrent
environment:
- PUID=1000
- PGID=1000
- TZ=UTC
- WEBUI_PORT=8080
- TORRENTING_PORT=6881
- WEBUI_PASSWORD=
- WEBUI_AUTH=false
volumes:
- "/path/to/containers/qbittorrent:/config"
- "/path/to/downloads:/downloads"
ports:
- 8080:8080
- 6881:6881
- 6881:6881
restart: unless-stopped
```

### AppJail Director

**.env**:

```
DIRECTOR_PROJECT=qbittorrent
PUID=1000
PGID=1000
TZ=UTC
WEBUI_PORT=8080
TORRENTING_PORT=6881
WEBUI_PASSWORD=
WEBUI_AUTH=false
```

**appjail-director.yml**:

```yaml
options:
- virtualnet: ': default'
- nat:
services:
qbittorrent:
name: qbittorrent
options:
- container: 'boot args:--pull'
oci:
user: root
environment:
- PUID: !ENV '${PUID}'
- PGID: !ENV '${PGID}'
- TZ: !ENV '${TZ}'
- WEBUI_PORT: !ENV '${WEBUI_PORT}'
- TORRENTING_PORT: !ENV '${TORRENTING_PORT}'
- WEBUI_PASSWORD: !ENV '${WEBUI_PASSWORD}'
- WEBUI_AUTH: !ENV '${WEBUI_AUTH}'
volumes:
- qbittorrent: /config
- downloads: /downloads
volumes:
qbittorrent:
device: '/path/to/containers/qbittorrent'
downloads:
device: 'downloads'
```

**Makejail**:

```
ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/qbittorrent:${tag}
```

### Podman CLI

```bash
podman run -d --name qbittorrent \
-p 8080:8080 \
-p 6881:6881 \
-p 6881:6881 \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=UTC \
-e WEBUI_PORT=8080 \
-e TORRENTING_PORT=6881 \
-e WEBUI_PASSWORD= \
-e WEBUI_AUTH=false \
-v /path/to/containers/qbittorrent:/config \
-v /path/to/downloads:/downloads \
ghcr.io/daemonless/qbittorrent:latest
```

### Ansible

```yaml
- name: Deploy qbittorrent
containers.podman.podman_container:
name: qbittorrent
image: ghcr.io/daemonless/qbittorrent:latest
state: started
restart_policy: always
env:
PUID: "1000"
PGID: "1000"
TZ: "UTC"
WEBUI_PORT: "8080"
TORRENTING_PORT: "6881"
WEBUI_PASSWORD: ""
WEBUI_AUTH: "false"
ports:
- "8080:8080"
- "6881:6881"
- "6881:6881"
volumes:
- "/path/to/containers/qbittorrent:/config"
- "/path/to/downloads:/downloads"
```

Access at: `http://localhost:8080`

## Parameters

### Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `PUID` | `1000` | User ID for the application process |
| `PGID` | `1000` | Group ID for the application process |
| `TZ` | `UTC` | Timezone for the container |
| `WEBUI_PORT` | `8080` | Web UI port (must match port mapping) |
| `TORRENTING_PORT` | `6881` | BitTorrent listening port for peer connections (must match port mapping) |
| `WEBUI_PASSWORD` | `` | Set a persistent admin password. If unset, a temporary password is generated each restart and printed to the logs. |
| `WEBUI_AUTH` | `false` | Set to 'true' to enable Web UI authentication. (Note: Upstream/FreeBSD port enables auth by default, but this image defaults to disabled). |

### Volumes

| Path | Description |
|------|-------------|
| `/config` | Configuration directory |
| `/downloads` | Download directory |

### Ports

| Port | Protocol | Description |
|------|----------|-------------|
| `8080` | TCP | Web UI |
| `6881` | TCP | BitTorrent peer connections (TCP/UDP) |
| `6881` | UDP | BitTorrent peer connections (TCP/UDP) |

**Architectures:** amd64
**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)
**Base:** FreeBSD 15.0

---

Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.