tsoichinghin/ovpn repository overview

⁠📡 OpenVPN Client Docker Image

Purpose: This image runs an OpenVPN client to create a secure VPN tunnel, allowing other containers to route traffic through it via network sharing.

⁠🛠️ Prerequisites

• OpenVPN Files:
  • .ovpn configuration file from your VPN provider.
  • auth.txt with credentials (username on line 1, password on line 2).
• Docker Setup:
  • Docker installed.
  • TUN/TAP device enabled (ls /dev/net/tun).

⁠⚙️ Configuration

⁠#### Required Settings

1. Volume Mount:

   • Map your OpenVPN config folder to /vpn.
   • Example: -v /root/ovpn:/vpn
   • Contains:
     • .ovpn file (e.g., client.ovpn).
     • auth.txt.

2. Environment Variable:

   • Set OVPN_FILE to your .ovpn filename.
   • Example: -e OVPN_FILE=client.ovpn
   • Note: Use -e OVPN_FILE=us.ovpn for us.ovpn.

⁠🚀 Running the Container

docker run -d \
  --restart always \
  --name ovpn \
  --cap-add=NET_ADMIN \
  --device=/dev/net/tun \
  -v /root/ovpn:/vpn \
  -e OVPN_FILE=client.ovpn \
  tsoichinghin/ovpn:latest

⁠#### Customizable Parameters

⁠🌐 Using with Other Containers

Route traffic through the VPN by sharing the OpenVPN container’s network.

Example:

docker run -d \
  --name my-app \
  --network container:ovpn \
  my-app-image

⁠🌍 Exposing Services

Map ports to access services (e.g., web UI) from the host.

Example:

docker run -d \
  --restart always \
  --name ovpn \
  --cap-add=NET_ADMIN \
  --device=/dev/net/tun \
  -v /root/ovpn:/vpn \
  -e OVPN_FILE=client.ovpn \
  -p 4449:4449 \
  tsoichinghin/ovpn:latest

• -p 4449:4449: Access services at http://<host-ip>:4449.

⁠🔒 Security & Notes

• Password Caching: Add auth-nocache to .ovpn.
• IPv6: Disable to prevent leaks:

  --sysctl net.ipv6.conf.all.disable_ipv6=1
  

  Copy
• Permissions:

  chmod 600 /root/ovpn/auth.txt
  

  Copy

  chmod 600 /root/ovpn/client.ovpn
  

  Copy

⁠🧪 Troubleshooting

1. View Logs:

   docker logs ovpn
   

   Copy
2. Check Files:

   ls -l /root/ovpn
   

   Copy

   docker run -it --rm -v /root/ovpn:/vpn ovpn
   

   Copy

   ls -l /vpn
   

   Copy
3. Test VPN:

   docker exec -it ovpn /bin/sh
   curl -4 ifconfig.me
   nslookup google.com
   

   Copy
4. Verify TUN/TAP:

   ls /dev/net/tun
   sudo modprobe tun
   

   Copy

⁠📋 Example Setup

1. Run OpenVPN:

   docker run -d \
     --restart always \
     --name ovpn \
     --cap-add=NET_ADMIN \
     --device=/dev/net/tun \
     -v /root/ovpn:/vpn \
     -e OVPN_FILE=client.ovpn \
     -p 4449:4449 \
     --sysctl net.ipv6.conf.all.disable_ipv6=1 \
     tsoichinghin/ovpn:latest
   

   Copy

2. Run App:

   docker run -d \
     --name my-web-app \
     --network container:ovpn \
     my-web-app-image
   

   Copy

3. Access Service:

   • Visit http://<host-ip>:4449.

⁠ℹ️ Support

Check logs (docker logs ovpn) or contact your VPN provider for issues. Ensure .ovpn and auth.txt are valid.