Repository files navigation

A small script to updateqBittorrent'slistening port automatically based on the VPN forwarded port inGluetun, compatible with Gluetun v4.

• Background
• How to use
• Configuration
• Docker network config
• Set up the development environment
• Contributing
• License

When I installed Gluetun on my home server as a way to tunnel my torrent clients' traffic through my VPN provider,I quickly encountered the issue that theforwarded portwasn't persisted across Gluetun restarts, or would sometimes even change suddenly.This would mean I could not reliably define the listening port in my torrent clients, and speeds would be affected.

I am of course not the first person to face this issue, and you will find on the internet many other scripts that do a similar job.However, I decided to create my own solution for several reasons :

• Many of the solutions I found use the file/tmp/gluetun/forwarded_port to get the port currently forwarded by Gluetun.
  However, this solution will be deprecated in the v4.0.0 release of Gluetun.
  This script makes instead use of the more robustcontrol server;
• I wanted to build something myself;
• I plan on expanding this program in the future to support other torrent clients

This script is packaged as a Docker container. The reason for this are multiple :

• This simplifies the distribution and makes this program available to all, regardless of the platform they use;
• Since Gluetun is, to my knowledge, only distributed as a Docker container, you will already be using Docker if you have the need for this repository;
• I wanted to gain more experience with Docker images and their build pipeline

To run this program, simply pull the imageghcr.io/mavdbussche/gluetun-helper:${TAG},where${TAG} is the image version tag (see 'Packages' on the right for a list of available tags).
You can also consult thedocker-compose.yml file at the root of this repository for an example configuration if you use Docker Compose.

To use this container, you will need to define some environment variables that are specific to your setup.Some defaults are provided, but they will most likely not work for you !

It is recommended to run this container on a Docker bridge network shared with Gluetun.While qBittorrent is probably runningthrough Gluetun if you need this script in the first place, that is not recommended/necessary forgluetun-helper.I propose two approaches for yourdocker-compose.yml file :

services:  gluetun:     [...]     hostname: gluetun     ports: N/A # No exposed ports necessary if Docker networks are used     networks: [ "some-network" ] # Shared with gluetun-helper  qbittorrent:     [...]     environment:       -WEBUI_PORT=8080     network_mode: "container:gluetun" # This container access the network through Gluetun's Docker namespace     ports: N/A     networks: N/A # All traffic goes through Gluetun; nothing can/should contact this container directly     depends_on:       gluetun:         condition: service_healthy         restart: true  gluetun-helper:     [...]     environment:       - GLUETUN_URL=http://gluetun:8000       - QBITTORRENT_URL=http://gluetun:8080 # All qBittorrent traffic goes through Gluetun => this is the de facto address of qBittorrent Web UI.       - QBITTORRENT_USERNAME=XXXXX       - QBITTORRENT_PASSWORD=XXXXXXXXXXXX     ports: N/A # This container doesn't need to expose any port to function     networks: [ "some-network" ] # Shared with Gluetun     depends_on:       gluetun:         condition: service_healthy       qbittorrent:         condition: service_started

services:  gluetun:     [...]     ports:       - "1.2.3.4:8000:8000" # Gluetun control server runs on 8000       - "1.2.3.4:8080:8080" # qBittorrent's web UI  qbittorrent:     [...]     environment:       -WEBUI_PORT=8080     network_mode: "container:gluetun" # This container access the network through Gluetun's Docker namespace     ports: N/A     depends_on:       gluetun:         condition: service_healthy         restart: true  gluetun-helper:     [...]     environment:       - GLUETUN_URL=http://1.2.3.4:8000       - QBITTORRENT_URL=http://1.2.3.4:8080 # All qBittorrent traffic goes through Gluetun => this is the de facto adress of qBittorrent Web UI.       - QBITTORRENT_USERNAME=XXXXX       - QBITTORRENT_PASSWORD=XXXXXXXXXXXX     ports: [] # This container doesn't need to expose any port to function     depends_on:       gluetun:         condition: service_healthy       qbittorrent:         condition: service_started

This project is built with Gradle. A distribution of Gradle Wrapper is included with this repository. Clone this repository, then execute the following commands to build and run the code locally :

./gradlew init # Prepare the environment./gradlew jar # To build an executable JARjava -jar app/buid/libs/${VERSION}.jar # Where VERSION is the name of the JAR from the previous step

You could also simply build the image directly using the Dockerfile included :

docker build . -t gluetun-helper:gluetun-helperdocker run gluetun-helper:gluetun-helper

If you feel like you found a bug in the program, please raise an issue on GitHub.
You can also use issues to request new features.

This program is licensed under theApache License, Version 2.0
This program uses the following dependencies:

• OkHttp, licensed under theApache License, Version 2.0
• Gson, licensed under theApache License, Version 2.0