Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.98 KB

protonvpn.md

File metadata and controls

69 lines (50 loc) · 2.98 KB
Raw

ProtonVPN

TLDR

docker run -it --rm --cap-add=NET_ADMIN -e VPN_SERVICE_PROVIDER=protonvpn \
-e OPENVPN_USER=abc -e OPENVPN_PASSWORD=abc \
-e SERVER_COUNTRIES=Netherlands qmcgaw/gluetun
version: "3"
services:
  gluetun:
    image: qmcgaw/gluetun
    cap_add:
      - NET_ADMIN
    environment:
      - VPN_SERVICE_PROVIDER=protonvpn
      - OPENVPN_USER=abc
      - OPENVPN_PASSWORD=abc
      - SERVER_COUNTRIES=Netherlands

💁 To use with Wireguard, download a configuration file from account.proton.me/u/0/vpn/WireGuard and head to the custom provider Wireguard section. Thanks to @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.

Required environment variables

Optional environment variables

  • SERVER_COUNTRIES: Comma separated list of countries
  • SERVER_REGIONS: Comma separated list of regions
  • SERVER_CITIES: Comma separated list of cities
  • SERVER_HOSTNAMES: Comma separated list of server hostnames
  • FREE_ONLY: Filter only free tier servers by setting it to on. It defaults to off.
  • VPN_ENDPOINT_PORT: Custom OpenVPN server endpoint port to use
    • For TCP: 443, 5995 or 8443
    • For UDP: 80, 443, 1194, 4569, 5060
    • Defaults are 1194 for UDP and 443 for TCP
  • VPN_PORT_FORWARDING: defaults to off and can be set to onto enable port forwarding on the VPN server. For Wireguard, additionally set VPN_PORT_FORWARDING_PROVIDER=protonvpn.

VPN server port forwarding

Requirements:

  • Add +pmp to your OpenVPN username (thanks to @mortimr)
  • VPN_PORT_FORWARDING=on
  • Pick a VPN server which supports 'P2P', see step 1 on this page. This will be partly automated for OpenVPN with #1582.
  • If you use Wireguard using the custom provider, set VPN_PORT_FORWARDING_PROVIDER=protonvpn

Multi hop regions

Simply set the SERVER_HOSTNAMES environment variable to a hostname corresponding to a multi hop region (see Servers).

For example setting SERVER_HOSTNAMES=ch-us-01a.protonvpn.com would set a multi hop with entry in Switzerland and exit in the US.

Moderate NAT/NAT Type 2

Paid ProtonVPN subscribers can optionally use Moderate NAT on their connections.

To do so, the OpenVPN username assigned by ProtonVPN should have +nr appended to the end of it.

Servers

To see a list of servers available, list the VPN servers with Gluetun.