From a5ce8d4898111a19f00a6e82f293f632ca705dd9 Mon Sep 17 00:00:00 2001
From: binhex <megalith01@gmail.com>
Date: Wed, 3 Mar 2021 12:04:01 +0000
Subject: [PATCH] include input and output port env vars and important note

---
 README.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 2801255..d7fc78e 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,8 @@ docker run -d \
     -e ENABLE_PRIVOXY=<yes|no> \
     -e LAN_NETWORK=<lan ipv4 network>/<cidr notation> \
     -e NAME_SERVERS=<name server ip(s)> \
-    -e ADDITIONAL_PORTS=<port number(s)> \
+    -e VPN_INPUT_PORTS=<port number(s)> \
+    -e VPN_OUTPUT_PORTS=<port number(s)> \
     -e DEBUG=<true|false> \
     -e WEBUI_PORT=<port for web interfance> \
     -e UMASK=<umask for created files> \
@@ -83,7 +84,8 @@ docker run -d \
     -e ENABLE_PRIVOXY=yes \
     -e LAN_NETWORK=192.168.1.0/24 \
     -e NAME_SERVERS=209.222.18.222,84.200.69.80,37.235.1.174,1.1.1.1,209.222.18.218,37.235.1.177,84.200.70.40,1.0.0.1 \
-    -e ADDITIONAL_PORTS=1234 \
+    -e VPN_INPUT_PORTS=1234 \
+    -e VPN_OUTPUT_PORTS=5678 \
     -e DEBUG=false \
     -e WEBUI_PORT=8080 \
     -e UMASK=000 \
@@ -129,7 +131,8 @@ docker run -d \
     -e ENABLE_PRIVOXY=yes \
     -e LAN_NETWORK=192.168.1.0/24 \
     -e NAME_SERVERS=209.222.18.222,84.200.69.80,37.235.1.174,1.1.1.1,209.222.18.218,37.235.1.177,84.200.70.40,1.0.0.1 \
-    -e ADDITIONAL_PORTS=1234 \
+    -e VPN_INPUT_PORTS=1234 \
+    -e VPN_OUTPUT_PORTS=5678 \
     -e DEBUG=false \
     -e WEBUI_PORT=8080 \
     -e UMASK=000 \
@@ -139,6 +142,9 @@ docker run -d \
 ```
 &nbsp;
 
+**IMPORTANT**  
+Please note 'VPN_INPUT_PORTS' is **NOT** to define the incoming port for the VPN, this environment variable is used to define port(s) you want to allow in to the VPN network when network binding multiple containers together, configuring this incorrectly with the VPN incoming port COULD leak to IP leakage, you have been warned.
+
 **OpenVPN**  
 Please note this Docker image does not include the required OpenVPN configuration file and certificates. These will typically be downloaded from your VPN providers website (look for OpenVPN configuration files), and generally are zipped.