gluetun-qbit-port-updater/README.md

2.0 KiB

Gluetun Qbittorrent Port Updater

Build status

Automatically updates qBittorrent's listening port to the port forwarded by Gluetun.

It works by checking the port in use by qBittorrent, and reading the port file created by Gluetun. If they do not match, it updates the port that qBittorrent is using.

Configuration

Currently the only configuration method is through environmental variables:

| Name | Description | Example | Required | Default | |---|---|---|---| | PORT_UPD_QBITTORRENT_LOGIN | The login information for the webui. | admin | false | empty string | | PORT_UPD_QBITTORRENT_PASSWORD | The password for the webui. | adminadmin | false | empty string | | PORT_UPD_QBITTORRENT_PORT | The port of the webui. | 8080 | true | | | PORT_UPD_QBITTORRENT_HOST | The host of the webui. | localhost | true | | | PORT_UPD_QBITTORRENT_HTTPS | Set to true if the connection to the webui is https encrypted. | false | true | | | PORT_UPD_PORT_FILE | The path to the file that contains the port. | /tmp/gluetun/forwarded_port | true | | | PORT_UPD_MAX_FAILURES | The amount of times to recheck the port before exiting. | 10 | false | 10 | | PORT_UPD_RECHECK_PERIOD | The period, in second, to check the port. | 60 | false | 60 |

Docker image

Docker images are published here.

You can run the following command to run a docker container:

$ docker run -it --rm --name qbit-port-updater \
    -v $PWD/shared/gluetun/forwarded_port:/tmp/gluetun/forwarded_port \
    -e PORT_UPD_QBITTORRENT_LOGIN=admin \
    -e PORT_UPD_QBITTORRENT_PASSWORD=adminadmin \
    -e PORT_UPD_QBITTORRENT_HTTPS=false \
    -e PORT_UPD_QBITTORRENT_HOST=localhost \
    -e PORT_UPD_QBITTORRENT_PORT=8080 \
    -e PORT_UPD_PORT_FILE=/tmp/gluetun/forwarded_port \
    git.seanomik.net/seanomik/gluetun-qbit-port-updater:rolling-d62e928a