final changes

setup/providers/airvpn.md

@@ -25,7 +25,7 @@ services:
       - VPN_TYPE=wireguard
       - WIREGUARD_PRIVATE_KEY=yCbHtKAgJASnJs2S/aZsjag9Fy04csmR4qDUDkJgX2c=
       - WIREGUARD_PRESHARED_KEY=yCbHtKAgJASnJs2S/aZsjag9Fy04csmR4qDUDkJgX2c=
-      - WIREGUARD_ADDRESSES=10.99.99.99/32 
+      - WIREGUARD_ADDRESSES=10.99.99.99/32
       - SERVER_COUNTRIES=Netherlands
 ```
 
@@ -89,5 +89,3 @@ If you want to use VPN server side port forwarding:
 1. Log in your AirVPN account at [airvpn.org/client](https://airvpn.org/client/)
 1. Obtain a port from [airvpn.org/ports](https://airvpn.org/ports/)
 1. Add the port to the environment variable `FIREWALL_VPN_INPUT_PORTS`
-
-

setup/providers/surfshark.md

@@ -1,20 +1,13 @@
 # Surfshark
 
-## WireGuard
+## TLDR
 
-## How to obtain your WireGuard connection details
-
-- Log into your SurfShark account
-- Select VPN from the left menu and then `Manual Setup`
-- Select `Deskop or mobile`
-- Choose `WireGuard`
-- Select `I don't have a keypair` and enter a name for the key (this can be anything)
-- Click `Generate a new keypair`
-- Make note of the `Private key`
-- Next select a location and download the config file (Ignore the information on screen as it will not work with GlueTUN)
-- Within the config file obtain the IP on the `Address` line this is used for the `WIREGUARD_ADDRESSES` to connect.
-
-### docker run
+```sh
+# OpenVPN
+docker run -it --rm --cap-add=NET_ADMIN -e VPN_SERVICE_PROVIDER=surfshark \
+-e OPENVPN_USER=abc -e OPENVPN_PASSWORD=abc \
+-e SERVER_COUNTRIES=Netherlands qmcgaw/gluetun
+```
 
 ```sh
 # Wireguard
@@ -25,8 +18,6 @@ docker run -it --rm --cap-add=NET_ADMIN -e VPN_SERVICE_PROVIDER=surfshark \
 -e SERVER_COUNTRIES=Netherlands qmcgaw/gluetun
 ```
 
-### docker compose
-
 ```yml
 version: "3"
 services:
@@ -42,29 +33,30 @@ services:
       - SERVER_COUNTRIES=Netherlands
 ```
 
-### WireGuard required environment variables
+## Required environment variables
 
 - `VPN_SERVICE_PROVIDER=surfshark`
-- `WIREGUARD_PRIVATE_KEY=your-private-key`
-- `WIREGUARD_ADDRESSES=ip-from-config-file`
-
-## OpenVPN
 
-### docker run
+### OpenVPN only
 
-```sh
-# OpenVPN
-docker run -it --rm --cap-add=NET_ADMIN -e VPN_SERVICE_PROVIDER=surfshark \
--e OPENVPN_USER=abc -e OPENVPN_PASSWORD=abc \
--e SERVER_COUNTRIES=Netherlands qmcgaw/gluetun
-```
-
-### Open VPN required environment variables
-
-- `VPN_SERVICE_PROVIDER=surfshark`
 - `OPENVPN_USER`
 - `OPENVPN_PASSWORD`
 
+### Wireguard only
+
+- `WIREGUARD_PRIVATE_KEY` is your 32 bytes key in base64 format. The private key can only be registered (and eventually generated) with these steps:
+  1. Log into your SurfShark account
+  1. Select *VPN* from the left menu
+  1. Select *Manual Setup*
+  1. Select *Deskop or mobile*
+  1. Select *WireGuard*
+  1. Select *I don't have a keypair* and enter a name for the key
+  1. Select *Generate a new keypair*
+  1. Use the **Private key** value for the `WIREGUARD_PRIVATE_KEY` environment variable
+  1. Next select a location and download the config file (Ignore the information on screen as it will not work with GlueTUN)
+  1. Within the config file obtain the IP on the `Address` line this is used for the `WIREGUARD_ADDRESSES` to connect.
+- `WIREGUARD_ADDRESSES` is the Wireguard IP network interface address in CIDR format `xx.xx.xx.xx/xx`. To obtain it, first download a Wireguard configuration file using same steps as for `WIREGUARD_PRIVATE_KEY` above. In the configuration file, locate the `Address` value and use its value here.
+
 ## Optional environment variables
 
 - `VPN_TYPE`: `openvpn` or `wireguard`