Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/wangyu-/tinyFecVPN
Browse files Browse the repository at this point in the history
  • Loading branch information
wangyu- committed Oct 31, 2017
2 parents 826817c + f66e30b commit 6e75976
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 22 deletions.
48 changes: 26 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,6 @@ For more details,check:

https://github.com/wangyu-/UDPspeeder/

# Performance Test(throughput)

Server is Vulr VPS in japan,CPU: single core 2.4GHz,ram: 512mb. Client is Bandwagonhost VPS in USA,CPU: single core 2.0GHZ,ram: 96mb。

### Test command

```
Server side:
./tinyvpn_amd64 -s -l 0.0.0.0:5533 --mode 0
iperf3 -s
Client side:
./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
iperf3 -c 10.22.22.1 -P10
```

### Test result

![image](/images/performance2.PNG)


# Getting Started

### Installing
Expand Down Expand Up @@ -104,6 +83,8 @@ main options:
--timeout <number> how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
--mode <number> fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
--report <number> turn on send/recv report, and set a period for reporting, unit: s
--re-connect re-connect after lost connection,only for client.
advanced options:
--mtu <number> mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
for mode 1, no packet will be split, the program just check if the mtu is exceed.
Expand Down Expand Up @@ -161,7 +142,30 @@ TinyFecVPN server only handles one client at same time,the connection of a new c

If `--keep-reconnect` is enabled , the client will try to get connection back after being kicked.

### Restriction

# Performance Test(throughput)

Server is Vulr VPS in japan,CPU: single core 2.4GHz,ram: 512mb. Client is Bandwagonhost VPS in USA,CPU: single core 2.0GHZ,ram: 96mb。

### Test command

```
Server side:
./tinyvpn_amd64 -s -l 0.0.0.0:5533 --mode 0
iperf3 -s
Client side:
./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
iperf3 -c 10.22.22.1 -P10
```

### Test result

![image](/images/performance2.PNG)



# Restriction

There is currently an intended restriction at server side.You cant use tinyFecVPN to access a third server directly. So,as a connection speed-up tool,when used alone,it only allows you to speed-up your connection to your server.You cant use it to bypass network firewalls directly.

Expand Down
1 change: 1 addition & 0 deletions doc/README.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ main options:
--timeout <number> how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
--mode <number> fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
--report <number> turn on send/recv report, and set a period for reporting, unit: s
--re-connect re-connect after lost connection,only for client.
advanced options:
--mtu <number> mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
for mode 1, no packet will be split, the program just check if the mtu is exceed.
Expand Down

0 comments on commit 6e75976

Please sign in to comment.