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.
123 Commits 2 Branches 53 Tags 757 KiB
Go 97.9%
Shell 1%
Makefile 0.6%
Batchfile 0.4%
fe522af42b
Go to file
Alex Tsai fe522af42b fix issue #8
2022-02-16 21:20:26 +08:00
common fix issue #8 2022-02-16 21:20:26 +08:00
register fix 2021-05-14 18:20:54 +08:00
scripts delete scripts 2021-12-21 15:39:17 +08:00
tcp support tcp 2021-12-21 19:20:01 +08:00
tun add dns 2021-12-15 17:16:29 +08:00
udp support tcp 2021-12-21 19:20:01 +08:00
ws fix issue #8 2022-02-16 21:20:26 +08:00
.gitignore update 2021-04-26 13:02:59 +08:00
.travis.yml update ws lib 2021-11-10 16:50:50 +08:00
Dockerfile add proxy 2021-09-09 17:00:44 +08:00
go.mod add counter 2021-12-19 22:24:40 +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 fix issue #8 2022-02-16 21:20:26 +08:00
README.md fix issue #8 2022-02-16 21:20:26 +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:
  -c string
        tun interface CIDR (default "172.16.0.10/24")
  -k string
        key (default "6w9z$C&F)J@NcRfWjXn3r4u7x!A%D*G-")
  -l string
        local address (default ":3000")
  -p string
        protocol tcp/udp/ws/wss (default "wss")
  -s string
        server address (default ":3001")
  -d string
        dns address (default "8.8.8.8:53")
  -path string
        websocket path (default "/way-to-freedom")
  -P    enable pporf server on :6060
  -S    server mode
  -g    client global mode
  -obfs enable obfuscation

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. Support IPv6
  3. Develop iOS app

License

The MIT License (MIT)