From 3a42f682245037c2ad8b24e94dd7c7f26c01cf89 Mon Sep 17 00:00:00 2001
From: "Quentin McGaw (desktop)" <quentin.mcgaw@gmail.com>
Date: Mon, 13 Sep 2021 16:19:29 -0400
Subject: [PATCH] Document custom provider for OpenVPN and Wireguard

---
 Setup/Environment variables.md | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/Setup/Environment variables.md b/Setup/Environment variables.md
index 86fdd7d..8a5f434 100644
--- a/Setup/Environment variables.md	
+++ b/Setup/Environment variables.md	
@@ -6,7 +6,7 @@
 
 | Variable | Default | Choices | Description |
 | --- | --- | --- | --- |
-| 🏁 `VPNSP` | `private internet access` | `cyberghost`, `fastestvpn`, `hidemyass`, `ivpn`, `mullvad`, `nordvpn`, `privado`, `private internet access`, `privatevpn`, `protonvpn`, `purevpn`, `surfshark`, `torguard`, `"vpn unlimited"`, `vyprvpn`, `wevpn`, `windscribe` | VPN Service Provider. 💁 Note this is more restricted if you use Wireguard |
+| 🏁 `VPNSP` | `private internet access` | [`custom`](#Custom), `cyberghost`, `fastestvpn`, `hidemyass`, `ivpn`, `mullvad`, `nordvpn`, `privado`, `private internet access`, `privatevpn`, `protonvpn`, `purevpn`, `surfshark`, `torguard`, `"vpn unlimited"`, `vyprvpn`, `wevpn`, `windscribe` | VPN Service Provider. 💁 Note this is more restricted if you use Wireguard |
 | `VPN_TYPE` | `openvpn` | `openvpn` or `wireguard` | VPN type to connect to the VPN server |
 | `PUBLICIP_FILE` | `/tmp/gluetun/ip` | Any filepath | Filepath to store the public IP address assigned |
 
@@ -198,6 +198,8 @@ You need to have your Openvpn private key file accessible to Gluetun, see [Clien
 | `CITY` | | Comma separated list of [Torguard cities](Torguard-Servers) | VPN server city, if any |
 | `SERVER_HOSTNAME` | | Comma separated list of [Torguard hostnames](Torguard-Servers) | VPN server hostname |
 
+- 💁 To use Wireguard, use the [Custom provider](#Custom)
+
 ### VPN Unlimited (KeepSolid)
 
 | Variable | Default | Choices | Description |
@@ -208,7 +210,8 @@ You need to have your Openvpn private key file accessible to Gluetun, see [Clien
 | `CITY` | | | Comma separated list of [cities](VPN-Unlimited-Servers) to choose the VPN server |
 | `SERVER_HOSTNAME` | | | Comma separated list of [hostnames](VPN-Unlimited-Servers) to choose the VPN server |
 
-You need to have your Openvpn private key file accessible to Gluetun, see [Client key](Client-key); and your Openvpn client certificate, see [Client certificate](Client-certificate)
+- ⚠️ You need to have your Openvpn private key file accessible to Gluetun, see [Client key](Client-key); and your Openvpn client certificate, see [Client certificate](Client-certificate)
+- 💁 To use Wireguard, use the [Custom provider](#Custom)
 
 ### Vyprvpn
 
@@ -232,7 +235,8 @@ You need to have your Openvpn private key file accessible to Gluetun, see [Clien
 | `SERVER_HOSTNAME` | | Comma separated list of [server hostnames](WeVPN-Servers) | Server hostname(s) |
 | `PORT` | | For `tcp`: `53`, `1195`, `1199`, `2018`; for `udp`: `80`, `1194`, `1198` | Custom VPN port to use |
 
-You need to have your Openvpn private key file accessible to Gluetun, see [Client key](Client-key).
+- ⚠️ You need to have your Openvpn private key file accessible to Gluetun, see [Client key](Client-key).
+- 💁 To use Wireguard, use the [Custom provider](#Custom)
 
 ### Windscribe
 
@@ -248,6 +252,27 @@ You need to have your Openvpn private key file accessible to Gluetun, see [Clien
 | 🏁 `WIREGUARD_ADDRESS` | | IP network in the format `xx.xx.xx.xx/xx` | Wireguard interface address, only required if `VPN_TYPE=wireguard`. Note this is usually specific by user and the same for all servers. |
 | `WIREGUARD_ENDPOINT_PORT` | | `53`, `80`, `123`, `443`, `1194`, `65142` | Wireguard server endpoint port to use |
 
+### Custom
+
+The `custom` VPN 'service provider' is to support [custom configuration files for OpenVPN](Openvpn-file) and
+custom configurations for Wireguard.
+
+The following variables are available for OpenVPN (only if `VPNTYPE=openvpn`):
+
+| Variable | Default | Choices | Description |
+| --- | --- | --- | --- |
+| 🏁 `OPENVPN_CUSTOM_CONFIG` | | File path | The path to your OpenVPN configuration file |
+
+On top of the existing [Wireguard variables](#Wireguard), the following variables are available for Wireguard (only if `VPNTYPE=wireguard`):
+
+| Variable | Default | Choices | Description |
+| --- | --- | --- | --- |
+| 🏁 `WIREGUARD_ENDPOINT_IP` | | Endpoint IP address | The server endpoint IP address |
+| 🏁 `WIREGUARD_ENDPOINT_PORT` | | Endpoint port | The server endpoint port, usually `51820` |
+| 🏁 `WIREGUARD_PUBLIC_KEY` | | Wireguard public key | The server public key |
+| 🏁 `WIREGUARD_PRIVATE_KEY` | | 32 bytes key in base64 format | Wireguard private key |
+| 🏁 `WIREGUARD_ADDRESS` | | IP network in the format `xx.xx.xx.xx/xx` | Wireguard interface address |
+
 ## DNS over TLS
 
 None of the following values are required.