qBittorrent-Auto-Port-Forward

qBittorrent-Auto-Port-Forward

Docker app from Exes' Repository

Overview

Set qBittorrent's forwarded port by reading the port number from a file. Useful if you your qBittorrent container is bound to a VPN client and your VPN client outputs the forwarded port to a file. ### Made for use with docker-wireguard-pia: - **Environment variable:** `PORT_FORWARDING=1` - **Environment variable:** `PORT_PERSIST=1` - **Environment variable:** `PORT_FILE=/pia/forwarded_port.txt` - **Volume:** `/my/host/dir:/pia:rw` ### Or for use with gluetun: - **Environment variable:** `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING=on` - **Environment variable:** `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE=/gluetun/forwarded_port.txt` - **Volume:** `/my/host/dir:/gluetun:rw`

qbittorrent-port-forward-file

A shell script and Docker container for automatically setting qBittorrent's listening port from a text file.

Config

Environment Variables

Variable Example Default Description
QBT_USERNAME username admin qBittorrent username
QBT_PASSWORD password adminadmin qBittorrent password
QBT_ADDR http://192.168.1.100:8080 http://localhost:8080 HTTP URL for the qBittorrent web UI, with port
PORT_FILE /config/my_file.txt /config/forwarded_port.txt Container path to the file containing the forwarded port number

Volumes

Host location Container location Mode Description
/my/host/dir/ /config ro The directory in which the forwared ports file is located

Docker Compose

services:
  qbittorrent-port-forwarder:
    container_name: qbittorrent-port-forwarder
    image: ghcr.io/claabs/qbittorrent-port-forward-file:latest
    environment:
      - QBT_USERNAME=admin
      - QBT_PASSWORD=adminadmin
      - QBT_ADDR=http://192.168.1.100:8080
      - PORT_FILE=/config/forwarded_port.txt
    volumes:
      - ./config:/config:ro
    restart: unless-stopped

Context

Made for use with docker-wireguard-pia (although you should use PORT_SCRIPT):

  • Environment variable: PORT_FORWARDING=1
  • Environment variable: PORT_PERSIST=1
  • Environment variable: PORT_FILE=/pia/forwarded_port.txt
  • Volume: /my/host/dir:/pia:rw

Or for use with gluetun:

  • Environment variable: PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING=on
  • Environment variable: PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE=/gluetun/forwarded_port.txt
  • Volume: /my/host/dir:/gluetun:rw

Development

Build Image

docker build . -t qbittorrent-port-forwarder

Run Container

docker run --rm -it -e QBT_ADDR=http://192.168.1.100:8080 -v $(pwd)/config:/config qbittorrent-port-forwarder:latest

Install qBittorrent-Auto-Port-Forward on Unraid in a few clicks.

Find qBittorrent-Auto-Port-Forward in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for qBittorrent-Auto-Port-Forward Review the template variables and paths Click Install

Download Statistics

141,421
Total Downloads
7,306
This Month
8,902
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
charlocharlie/qbittorrent-port-forward-file
Last Updated2025-12-06
First Seen2025-03-14

Runtime arguments

Network
bridge
Shell
sh
Privileged
false
Extra Params
--restart unless-stopped

Template configuration

Port Forwarding FilePathro

Container path to the file containing the forwarded port number. The container path must be /config/forwarded_port.txt, but you can use other file types.

Target
/config/forwarded_port.txt
Default
/config/forwarded_port.txt
QBT_USERNAMEVariable

qBittorrent username.

Default
admin
QBT_PASSWORDVariable

qBittorrent password.

Default
adminadmin
QBT_ADDRVariable

HTTP URL for the qBittorrent web UI, with port.

Default
http://localhost:8080
PORT_FILEVariable

Container path to the file containing the forwarded port number. The container path must be /config/forwarded_port.txt, but you can use other file types.

Default
/config/forwarded_port.txt
Value
/config/forwarded_port.txt