diff --git a/README.md b/README.md index 8007f8d..cbc1ec2 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,6 @@ $ docker run --privileged -d \ -e "VPN_ENABLED=yes" \ -e "LAN_NETWORK=192.168.1.0/24" \ -e "NAME_SERVERS=8.8.8.8,8.8.4.4" \ - -e "PUID=99" \ - -e "PGID=100" \ -p 8080:8080 \ -p 8999:8999 \ -p 8999:8999/udp \ @@ -38,10 +36,14 @@ $ docker run --privileged -d \ | Variable | Required | Function | Example | |----------|----------|----------|----------| |`VPN_ENABLED`| Yes | Enable VPN? (yes/no) Default:yes|`VPN_ENABLED=yes`| +|`VPN_USERNAME`| No | If username and password provided, configures ovpn file automatically |`VPN_USERNAME=ad8f64c02a2de`| +|`VPN_PASSWORD`| No | If username and password provided, configures ovpn file automatically |`VPN_PASSWORD=ac98df79ed7fb`| |`LAN_NETWORK`| Yes | Local Network with CIDR notation |`LAN_NETWORK=192.168.1.0/24`| |`NAME_SERVERS`| No | Comma delimited name servers |`NAME_SERVERS=8.8.8.8,8.8.4.4`| |`PUID`| No | UID applied to config files and downloads |`PUID=99`| |`PGID`| No | GID applied to config files and downloads |`PGID=100`| +|`WEBUI_PORT_ENV`| No | Applies WebUI port for qBittorrents config file at boot |`WEBUI_PORT_ENV=8080`| +|`INCOMING_PORT_ENV`| No | Applies Incoming port for qBittorrents config file at boot |`INCOMING_PORT_ENV=8999`| ## Volumes | Volume | Required | Function | Example | @@ -109,8 +111,6 @@ $ docker run --privileged -d \ -e "VPN_ENABLED=yes" \ -e "LAN_NETWORK=192.168.1.0/24" \ -e "NAME_SERVERS=8.8.8.8,8.8.4.4" \ - -e "PUID=99" \ - -e "PGID=100" \ -p 8080:8080 \ -p 8999:8999 \ -p 8999:8999/udp \