gluetun-qbit-port-updater/README.md

34 lines
1.9 KiB
Markdown
Raw Normal View History

2023-12-14 00:36:36 +00:00
# Gluetun Qbittorrent Port Updater
Automatically updates qBittorrent's listening port to the port forwarded by [Gluetun](https://github.com/qdm12/gluetun/).
2024-05-19 03:26:03 +00:00
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.
2023-12-14 00:36:36 +00:00
## Configuration
Currently the only configuration method is through environmental variables:
2024-05-19 03:26:03 +00:00
| Name | Description | Example | Required | Default |
2023-12-14 00:36:36 +00:00
|---|---|---|---|
2024-05-19 03:26:03 +00:00
| 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 |
2024-05-19 17:03:35 +00:00
## Docker image
Docker images are published [here](https://git.seanomik.net/SeanOMik/-/packages/container/gluetun-qbit-port-updater).
You can run the following command to run a docker container:
```shell
$ 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
```