154 lines
3.2 KiB
Markdown
154 lines
3.2 KiB
Markdown
# qbittorrent
|
|
|
|
> Auto-generated from `docker-compose.yml`
|
|
|
|
## `gluetun`
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| **Image** | `qmcgaw/gluetun` |
|
|
| **Container** | `qbittorrent_gluetun` |
|
|
| **Restart** | `unless-stopped` |
|
|
|
|
### Environment
|
|
|
|
**Env files:** `../.env`, `.env`
|
|
|
|
| Variable | Value |
|
|
|----------|-------|
|
|
| `VPN_SERVICE_PROVIDER` | `protonvpn` |
|
|
| `VPN_TYPE` | `wireguard` |
|
|
| `VPN_PORT_FORWARDING` | `on` |
|
|
| `TZ` | `${TZ}` |
|
|
| `SERVER_COUNTRIES` | `New Zealand` |
|
|
| `PORT_FORWARD_ONLY` | `on` |
|
|
| `VPN_PORT_FORWARDING_UP_COMMAND` | `/bin/sh -c 'wget -O- --post-data "json={\"listen_port\":{{PORTS}}}" http://localhost:8080/api/v2/app/setPreferences 2>/dev/null || true'` |
|
|
|
|
### Secrets (from `.env.example`)
|
|
|
|
These variables must be set in the service's `.env` file:
|
|
|
|
| Variable | Default |
|
|
|----------|---------|
|
|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
|
|
| `QBITTORRENT_PORT` | `8080` |
|
|
| `JACKETT_PORT` | `9117` |
|
|
|
|
### Ports
|
|
|
|
| Host | Container | Protocol |
|
|
|------|-----------|----------|
|
|
| `${QBITTORRENT_PORT:-8080}` | `8080` | tcp |
|
|
| `${JACKETT_PORT:-9117}` | `9117` | tcp |
|
|
|
|
### Volumes
|
|
|
|
| Host Path | Container Path | Mode |
|
|
|-----------|----------------|------|
|
|
| `${STORAGE_PATH}/qbittorrent/gluetun` | `/gluetun` | rw |
|
|
| `${STORAGE_PATH}/qbittorrent/wireguard` | `/gluetun/wireguard` | rw |
|
|
|
|
### Networks
|
|
|
|
- `qbittorrent` (internal)
|
|
|
|
### Capabilities
|
|
|
|
`NET_ADMIN`
|
|
|
|
### Devices
|
|
|
|
- `/dev/net/tun:/dev/net/tun`
|
|
|
|
### Networks (compose-level)
|
|
|
|
- `qbittorrent` (internal)
|
|
|
|
---
|
|
|
|
## `qbittorrent`
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| **Image** | `lscr.io/linuxserver/qbittorrent:latest` |
|
|
| **Container** | `qbittorrent` |
|
|
| **Restart** | `unless-stopped` |
|
|
|
|
### Environment
|
|
|
|
| Variable | Value |
|
|
|----------|-------|
|
|
| `TZ` | `${TZ}` |
|
|
| `WEBUI_PORT` | `8080` |
|
|
| `PUID` | `${USER_UID}` |
|
|
| `PGID` | `${USER_GID}` |
|
|
|
|
### Secrets (from `.env.example`)
|
|
|
|
These variables must be set in the service's `.env` file:
|
|
|
|
| Variable | Default |
|
|
|----------|---------|
|
|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
|
|
| `QBITTORRENT_PORT` | `8080` |
|
|
| `JACKETT_PORT` | `9117` |
|
|
|
|
### Volumes
|
|
|
|
| Host Path | Container Path | Mode |
|
|
|-----------|----------------|------|
|
|
| `${STORAGE_PATH}/qbittorrent/config` | `/config` | rw |
|
|
| `${MEDIA_PATH}/torrents` | `/downloads` | rw |
|
|
|
|
### Dependencies
|
|
|
|
- `gluetun`
|
|
|
|
### Networks (compose-level)
|
|
|
|
- `qbittorrent` (internal)
|
|
|
|
---
|
|
|
|
## `jackett`
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| **Image** | `linuxserver/jackett:latest` |
|
|
| **Container** | `jackett` |
|
|
| **Restart** | `unless-stopped` |
|
|
|
|
### Environment
|
|
|
|
| Variable | Value |
|
|
|----------|-------|
|
|
| `TZ` | `${TZ}` |
|
|
| `PUID` | `${USER_UID}` |
|
|
| `PGID` | `${USER_GID}` |
|
|
|
|
### Secrets (from `.env.example`)
|
|
|
|
These variables must be set in the service's `.env` file:
|
|
|
|
| Variable | Default |
|
|
|----------|---------|
|
|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
|
|
| `QBITTORRENT_PORT` | `8080` |
|
|
| `JACKETT_PORT` | `9117` |
|
|
|
|
### Volumes
|
|
|
|
| Host Path | Container Path | Mode |
|
|
|-----------|----------------|------|
|
|
| `${STORAGE_PATH}/qbittorrent/config/jackett` | `/config` | rw |
|
|
|
|
### Dependencies
|
|
|
|
- `gluetun`
|
|
|
|
### Networks (compose-level)
|
|
|
|
- `qbittorrent` (internal)
|
|
|
|
---
|