feat: readme

README.md

@@ -64,6 +64,7 @@ services:
         devices:
             - /dev/net/tun
         ports:
+            - 1080:1080 #if you want to use the socks5 server
             - 9091:9091 #we open here the port for transmission, as this container will be the access point for the others
         restart: unless-stopped
         dns:
@@ -101,10 +102,13 @@ If you want to attach a container to the VPN, you can simply run:
 sudo docker run -it --net=container:CONTAINER_NAME alpine /bin/sh
 ```
 
-If you want access to an attached container's web ui you will also need to expose those ports.  The attached container must not be started until this container is up and fully running.
+If you want access to an attached container's web ui you will also need to expose those ports.  
+The attached container must not be started until this container is up and fully running.
 
 If you face network connection problems, I suggest you to set a specific DNS server for each container.
 
+Alternatively, if your software supports it, you can use the socks5 server embedded in this container. It will redirect your traffic through the Surfshark's VPN.
+
 ## Provide OpenVPN Configs Manually
 
 Sometimes the startup script fails to download OpenVPN configs file from Surfshark's website, possibly due to the DDoS protection on it.

startup.sh

@@ -5,16 +5,16 @@ if [ -z "${OVPN_CONFIGS}" ]; then
   OVPN_CONFIGS=ovpn_configs.zip
 fi
 unzip "${OVPN_CONFIGS}" -d ovpn_configs
-cd ovpn_configs || exit
+cd ovpn_configs
 VPN_FILE=$(ls "${SURFSHARK_COUNTRY}"* | grep "${SURFSHARK_CITY}" | grep "${CONNECTION_TYPE}" | shuf | head -n 1)
-echo Chose: "${VPN_FILE}"
+echo Chose: ${VPN_FILE}
 printf "${SURFSHARK_USER}\n${SURFSHARK_PASSWORD}" > vpn-auth.txt
 
-if [ -n "${LAN_NETWORK}"  ]
+if [ -n ${LAN_NETWORK}  ]
 then
     DEFAULT_GATEWAY=$(ip -4 route list 0/0 | cut -d ' ' -f 3)
 
-    splitSubnets=$(echo "${LAN_NETWORK}" | tr "," "\n")
+    splitSubnets=$(echo ${LAN_NETWORK} | tr "," "\n")
 
     for subnet in $splitSubnets
     do