Skip to content

Commit aa5a7ed

Browse files
committed
add example for proton vpn port forwarding setup
1 parent ee041f3 commit aa5a7ed

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

setup/advanced/vpn-port-forwarding.md

+9
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ Notes:
3434
- one can bind mount a shell script in Gluetun and execute it with for example `VPN_PORT_FORWARDING_UP_COMMAND=/bin/sh -c /gluetun/myscript.sh` - 💁 feel free to propose a pull request to add commonly used shell scripts for port forwarding!
3535
- the output of the command is written to the port forwarding logger within Gluetun
3636

37+
### qBittorrent Example
38+
39+
See [qbittorrent-port-updater.sh](scripts/qbittorrent-port-updater.sh) for an example of how this can be done. Add a bind mount to this script and then refert to it: `VPN_PORT_FORWARDING_UP_COMMAND=/bin/sh -c "/tmp/qbit-port-updater.sh {{PORTS}}"`
40+
41+
Notes:
42+
43+
- In order to get the call working make sure port qBittorrent is listening on is open. For example `- 8080:8080` to the ports definition. Without this calls do not go through.
44+
- Add `127.0.0.1/32` to bypass authentication settings for qBittorrent.
45+
3746
## Allow a forwarded port through the firewall
3847

3948
For non-native integrations where you have a designated forwarded port from your VPN provider, you can allow it by adding it to the environment variable `FIREWALL_VPN_INPUT_PORTS`.

setup/providers/protonvpn.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ services:
3535
- SERVER_COUNTRIES=Netherlands
3636
```
3737
38-
💁 To use with Wireguard, download a configuration file from [account.proton.me/u/0/vpn/WireGuard](https://account.proton.me/u/0/vpn/WireGuard) and head to [the custom provider Wireguard section](custom.md#wireguard). Thanks to [@pvanryn](https://github.com/pvanryn) for pointing this out. Note however you cannot filter servers as easily as with OpenVPN since each server uses its own private key and/or peer address.
38+
💁 To use with Wireguard, download a configuration file from [account.proton.me/u/0/vpn/WireGuard](https://account.proton.me/u/0/vpn/WireGuard) and set the `WIREGUARD_PRIVATE_KEY`. You can do a [the custom provider Wireguard section](custom.md#wireguard) to pick a specific server. Thanks to [@pvanryn](https://github.com/pvanryn) for pointing this out.
3939

4040
## Required environment variables
4141

@@ -75,6 +75,7 @@ Requirements:
7575
- Add `+pmp` to your OpenVPN username (thanks to [@mortimr](https://github.com/qdm12/gluetun/issues/1760#issuecomment-1669518288))
7676
- `VPN_PORT_FORWARDING=on`
7777
- If you use **Wireguard** using the custom provider, set `VPN_PORT_FORWARDING_PROVIDER=protonvpn`
78+
- See [custom port forwarding updown command](advanced/vpn-port-forwarding.md#custom-port-forwarding-updown-command) for examples of how to automate this.
7879

7980
## Multi hop regions
8081

0 commit comments

Comments
 (0)