https://github.com/thehxdev/tun2socks-vpn
Simple bash script to route all the traffic through a socks5 proxy with tun2socks
https://github.com/thehxdev/tun2socks-vpn
Last synced: 11 months ago
JSON representation
Simple bash script to route all the traffic through a socks5 proxy with tun2socks
- Host: GitHub
- URL: https://github.com/thehxdev/tun2socks-vpn
- Owner: thehxdev
- Created: 2024-12-27T19:46:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-02T09:57:07.000Z (11 months ago)
- Last Synced: 2025-07-02T10:48:55.287Z (11 months ago)
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tun2socks VPN
A simple Bash script to configure and run [tun2socks](https://github.com/xjasonlyu/tun2socks) on your Linux machine for
creating a VPN tunnel that routes all of your traffic to a socks5 proxy.
This script can be used with [Xray-Core](https://github.com/xtls/xray-core) or other proxy/tunneling solutions that does not
support VPN-Mode for routing and tunneling all of your traffic.
> [!WARNING]
> This software uses `systemd-run` command. It will not work on non-systemd systems.
## Install
First of all install [tun2socks](https://github.com/xjasonlyu/tun2socks). **It MUST be in your PATH.**
Then you can just put `vpn-mode` file in `/usr/local/bin` and use it. The command below will do this for you:
```bash
sudo curl -L -o '/usr/local/bin/vpn-mode' 'https://raw.githubusercontent.com/thehxdev/tun2socks-vpn/refs/heads/main/vpn-mode'
sudo chmod +x /usr/local/bin/vpn-mode
```
Then you need a config file. You can find an example config in [vpn-config](vpn-config). Download the config file:
```bash
curl -L -o "$HOME/vpn-config" 'https://raw.githubusercontent.com/thehxdev/tun2socks-vpn/refs/heads/main/vpn-config'
```
Edit the config to fit your environment:
```bash
# Your VPN server public IP address
# example: '10.10.10.1'
CONFIG_EXTERNAL_SERVER_IP=''
# List of IP CIDRs that you want to exclude
# example: ('192.168.1.0/24' '10.10.0.0/16')
CONFIG_EXCLUDE_CIDRS=()
# Your Socks5 proxy server
CONFIG_PROXY='socks5://127.0.0.1:10808'
```
## Run
There are only two commands (Must be run as root):
```bash
# Running tun2socks
sudo vpn-mode run $HOME/vpn-config
# Kill tun2socks and cleanup everything
sudo vpn-mode kill
```