This commit is contained in:
mrhotio 2025-12-25 11:40:14 +01:00
parent b0781700a1
commit 9a2bc510b1

View File

@ -12,7 +12,7 @@ Affiliate links:
5. There needs to be a file `wg0.conf` (for PIA this is done automatically, see `VPN_PROVIDER` variable) located in `/config/wireguard` and you need to set the variable `VPN_ENABLED` to `true` for the VPN to start. If you'd like to execute some of your own bash scripts you can place the scripts alongside your `wg0.conf` file, called `wg0-pre.sh` (before vpn is up), `wg0-post.sh` (after vpn is up) or `wg0-port.sh` (after forwarded port change).
6. Auto retrieve a forwarded port and configure the supported app if set to `true` or if you can manually request/set a forwarded port in the VPN provider's web interface, fill in the port number (just the number). Useful website to check for open ports is [YouGetSignal](https://www.yougetsignal.com/tools/open-ports){: target=_blank rel="noopener" } and [ipleak.net](https://ipleak.net){: target=_blank rel="noopener" } to leak test with `.torrent` file.
6. Auto retrieve a forwarded port and configure the supported app if set to `true` and `VPN_PROVIDER=proton` or `VPN_PROVIDER=pia`. If you can manually request/set a forwarded port in the VPN provider's web interface, fill in the port number (just the number). If you set it to `true` and you've got `VPN_PROVIDER=generic`, you can manually create and manipulate the file `/config/wireguard/forwarded_port`. Useful website to check for open ports is [YouGetSignal](https://www.yougetsignal.com/tools/open-ports){: target=_blank rel="noopener" } and [ipleak.net](https://ipleak.net){: target=_blank rel="noopener" } to leak test with `.torrent` file.
7. By default a random server is used, but if you prefer a certain region you can fill in the region id. A list of available regions can be found in `/config/wireguard` after the first start. If you're seeing an error message `shuf: getrandom: Function not implemented`, you can't let it pick one randomly and are forced to fill in a region id.
@ -30,7 +30,7 @@ Affiliate links:
14. If you'd like to keep using the same forwarded port until it expires, set this to `true`.
15. Adds a redirect for the forwarded port from your vpn provider to the internal port on which the app runs, ports in this list are also not blocked on the wireguard interface, so this var is also useful if you want to expose a port on both your LAN and VPN. Values like `32400/tcp` will use the port from `VPN_AUTO_PORT_FORWARD` to create the redirect or if set to `true` the forwarded port from pia/proton. Use `3000@3001/tcp,3002@3003/tcp` syntax for extra static redirects. The only known usecase as of right now is Plex and exposing it on the VPN with a non configurable forwarded port, because it's not possible to run Plex on anything else but 32400. Useful website to check for open ports is [YouGetSignal](https://www.yougetsignal.com/tools/open-ports){: target=_blank rel="noopener" } and [ipleak.net](https://ipleak.net){: target=_blank rel="noopener" } to leak test with `.torrent` file.
15. Adds a redirect from the port before `@` to the port after, with `udp or tcp` after the `/`. Ports in this list are also exposed on the wireguard interface. Values like `32400/tcp` without the `@` will use the port from `VPN_AUTO_PORT_FORWARD` for the redirect or if set to `true` the forwarded port received from pia/proton (In more detail: it'll use the port from `/config/wireguard/forwarded_port` if `VPN_AUTO_PORT_FORWARD` is not set to `false`). Use `3000@3001/tcp,3002@3003/tcp` syntax for static redirects. If you do `6677@6677/tcp` (same port), a redirect won't be added, but it'll just expose the port. A known usecase as of right now is Plex and exposing it on the VPN (if you can't get 32400 from your VPN provider), because it's not possible to run Plex on anything else but 32400.
16. Some of the possible values are for example `wg`, `8.8.8.8` or `1.1.1.1@853#cloudflare-dns.com` seperated by a `,`. The value `wg` will use the nameservers from the `wg0.conf` file. A value in the format `8.8.8.8` is to use a plain old nameserver. A value in the format `1.1.1.1@853#cloudflare-dns.com` will add a `DNS over TLS` nameserver, this will override all other regular nameservers. Leaving the variable empty will allow Unbound to work in recursive mode.