github/vtun
5
0
Fork 0
mirror of https://github.com/net-byte/vtun synced 2024-03-14 10:50:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
A simple VPN written in Go.
142 Commits 2 Branches 53 Tags 757 KiB
Go 97.9%
Shell 1%
Makefile 0.6%
Batchfile 0.4%
ad123eb093
Go to file
netbyte ad123eb093 fix
2022-04-13 10:11:24 +08:00
common fix cache key 2022-04-07 21:52:47 +08:00
register fix 2021-05-14 18:20:54 +08:00
scripts delete scripts 2021-12-21 15:39:17 +08:00
tcp fix 2022-04-13 10:11:24 +08:00
tun fix 2022-03-20 21:54:23 +08:00
udp fix cache key 2022-04-07 21:52:47 +08:00
ws fix 2022-04-13 10:11:24 +08:00
.gitignore update 2021-04-26 13:02:59 +08:00
.travis.yml code refactor 2022-03-20 21:36:07 +08:00
Dockerfile update dockerfile 2022-03-20 21:46:58 +08:00
go.mod code refactor 2022-03-20 21:36:07 +08:00
go.sum add counter 2021-12-19 22:24:40 +08:00
LICENSE Add vtun 2020-10-27 22:17:50 +08:00
main.go code refactor 2022-03-20 21:36:07 +08:00
README.md update readme 2022-04-07 22:06:20 +08:00

README.md

vtun

A simple VPN written in golang.

Travis Go Report Card image image

Features

  • VPN over tcp
  • VPN over udp
  • VPN over websocket

Usage

Usage of ./vtun:
  -S    server mode
  -c string
        tun interface cidr (default "172.16.0.10/24")
  -d string
        dns address (default "8.8.8.8:53")
  -g    client global mode
  -k string
        key (default "freedom@2022")
  -l string
        local address (default ":3000")
  -mtu int
        tun mtu (default 1500)
  -obfs
        enable data obfuscation
  -p string
        protocol tcp/udp/ws/wss (default "wss")
  -path string
        websocket path (default "/freedom")
  -s string
        server address (default ":3001")
  -t int
        dial timeout in seconds (default 30)

Build

sh scripts/build.sh

Client

sudo ./vtun-linux-amd64 -l=:3000 -s=server-addr:3001 -c=172.16.0.10/24 -k=123456

Client with global mode(routing all your traffic to server)

sudo ./vtun-linux-amd64 -l=:3000 -s=server-addr:3001 -c=172.16.0.10/24 -k=123456 -g

Server

sudo ./vtun-linux-amd64 -S -l=:3001 -c=172.16.0.1/24 -k=123456

Server setup on Linux

  1. Add TLS for websocket,reverse proxy server(3001) via nginx/caddy(443)

  2. Enable IP forwarding on server

  sudo echo 1 > /proc/sys/net/ipv4/ip_forward
  sudo sysctl -p
  // eth0 is the name of your public network interface
  sudo iptables -t nat -A POSTROUTING -s 172.16.0.0/24 -o eth0 -j MASQUERADE

Docker

Run client

docker run  -d --privileged --restart=always --net=host --name vtun-client netbyte/vtun -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456

Run client with global mode

docker run  -d --privileged --restart=always --net=host --name vtun-client netbyte/vtun -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456 -g

Run server

docker run  -d --privileged --restart=always --net=host --name vtun-server netbyte/vtun -S -l :3001 -c 172.16.0.1/24 -k 123456

Mobile client

Android

TODO (help wanted)

  1. Support windows
  2. Develop iOS app

License

The MIT License (MIT)