diff --git a/README.md b/README.md index f185051..8d9f0e8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # UDPspeeder Network Speed-Up Tool. Boost your Connection on a High Lantency High Packet-Loss Link by using Forward Error Correction. -When used alone,UDPspeeder speeds-up only UDP connection.Nevertheless,if you used UDPspeeder + any UDP-based VPN together,you can speed-up any traffic(include TCP/UDP/ICMP),currently OpenVPN/L2TP/ShadowVPN are confirmed to be supported。 +When used alone, UDPspeeder speeds-up only UDP connection. Nevertheless, if you used UDPspeeder + any UDP-based VPN together, +you can speed-up any traffic(include TCP/UDP/ICMP), currently OpenVPN/L2TP/ShadowVPN are confirmed to be supported。 ![](/images/en/udpspeeder.PNG) @@ -26,13 +27,13 @@ tested on a link with 100ms latency and 10% packet loss at both direction ![](/images/en/scp_compare2.PNG) # Supported Platforms -Linux host (including desktop Linux,Android phone/tablet,OpenWRT router,or Raspberry PI). +Linux host (including desktop Linux,Android phone/tablet, OpenWRT router, or Raspberry PI). For Windows and MacOS You can run UDPspeeder inside [this](https://github.com/wangyu-/udp2raw-tunnel/releases/download/20170918.0/lede-17.01.2-x86_virtual_machine_image_with_udp2raw_pre_installed.zip) 7.5mb virtual machine image. # How does it work -UDPspeeder uses FEC(Forward Error Correction) to reduce packet loss rate,at the cost of addtional bandwidth.The algorithm for FEC is called Reed-Solomon. +UDPspeeder uses FEC(Forward Error Correction) to reduce packet loss rate, at the cost of addtional bandwidth. The algorithm for FEC is called Reed-Solomon. ![image0](/images/en/fec.PNG) @@ -66,7 +67,7 @@ Assume your server ip is 44.55.66.77, you have a service listening on udp port 7 ./speederv2 -c -l0.0.0.0:3333 -r44.55.66.77:4096 -f20:10 -k "passwd" ``` -Now connecting to UDP port 3333 at the client side is equivalent to connecting to port 7777 at the server side,and the connection is boosted by UDPspeeder. +Now connecting to UDP port 3333 at the client side is equivalent to connecting to port 7777 at the server side, and the connection is boosted by UDPspeeder. ##### Note @@ -74,7 +75,7 @@ Now connecting to UDP port 3333 at the client side is equivalent to connecting t `-k` enables simple XOR encryption to confuse DPI(Deep Packet Inspection) -To run stably,pay attention to MTU. +To run stably, pay attention to MTU. # Advanced Topic ### Full Options @@ -125,14 +126,14 @@ log and help options: ``` #### `--fifo` option -Use a fifo(named pipe) for sending commands to the running program. For example `--fifo fifo.file`,you can use following commands to change parameters dynamically: +Use a fifo(named pipe) for sending commands to the running program. For example `--fifo fifo.file`, you can use following commands to change parameters dynamically: ``` -echo fec 19:9 >fifo.file -echo mtu 1100 >fifo.file -echo timeout 5 >fifo.file -echo queue-len 100 >fifo.file -echo mode 0 >fifo.file +echo fec 19:9 > fifo.file +echo mtu 1100 > fifo.file +echo timeout 5 > fifo.file +echo queue-len 100 > fifo.file +echo mode 0 > fifo.file ``` -### Speed-Up any traffic with OpenVPN+UDPspeeder +### Speed-Up any traffic with OpenVPN + UDPspeeder Check [UDPspeeder + openvpn config guide](/doc/udpspeeder_openvpn.md). diff --git a/doc/README.zh-cn.md b/doc/README.zh-cn.md index f36ef3b..5ceec59 100644 --- a/doc/README.zh-cn.md +++ b/doc/README.zh-cn.md @@ -17,7 +17,7 @@ ![image0](/images/cn/scp_compare.PNG) #### 原理简介 -主要原理是通过冗余数据来对抗网络的丢包,发送冗余数据的方式支持FEC(Forward Error Correction)和多倍发包,其中FEC算法是Reed-Solomon。 +主要原理是通过冗余数据来对抗网络的丢包,发送冗余数据的方式支持FEC(Forward Error Correction)和多倍发包,其中FEC算法是Reed-Solomon。 FEC方式的原理图: @@ -28,7 +28,7 @@ FEC方式的原理图: 在多个冗余包之间引入延迟(时间可配)来对抗突发性的丢包,避开中间路由器因为瞬时buffer长度过长而连续丢掉所有副本。 -模拟一定的延迟抖动(时间可配),这样上层应用计算出来的RTT方差会更大,以等待后续冗余包的到达,不至于发生在冗余包到达之前就触发重传的尴尬。 +模拟一定的延迟抖动(时间可配),这样上层应用计算出来的RTT方差会更大,以等待后续冗余包的到达,不至于发生在冗余包到达之前就触发重传的尴尬。 输出UDP收发情况报告,可以看出丢包率。 @@ -132,7 +132,7 @@ log and help options: 指定fec编码器在编码时候最多可以引入多大的延迟。越高fec越有效率,加速游戏时调低可以降低延迟。 ##### `--mode` 选项 和 `--mtu`选项 -fec编码器的工作模式。对于mode 0,编码器会积攒一定数量的packet,然后把他们合并再切成等长的片段(切分长度由--mtu指定)。对于mode 1,编码器不会做任何切分,而是会把packet按最大长度对齐,fec冗余包的长度为对齐后的长度(最大长度)。 +fec编码器的工作模式。对于mode 0,编码器会积攒一定数量的packet,然后把他们合并再切成等长的片段(切分长度由--mtu指定)。对于mode 1,编码器不会做任何切分,而是会把packet按最大长度对齐,fec冗余包的长度为对齐后的长度(最大长度)。 mode 0更省流量,在丢包率正常的情况下效果和mode 1是一样的;mode 1延迟更低,在极高丢包的情况下表现更好。 @@ -142,7 +142,7 @@ mode 0模式的流量消耗基本完全透明。mode 1因为涉及到数据按 mode 0模式数据包一般不会乱序,除非网络本身有严重乱序;mode 1模式被恢复的数据包可能会乱序,不过UDP本来就允许乱序,对绝大多数应用没有影响。mode 0模式反而可以纠正一些乱序情况。 -mode 0模式允许你发送的数据包大小超过物理接口的MTU而几乎不引起性能损失(而普通的ip分片做不到这点),目前最高支持到2000字节,2000字节已经可以应对任何应用了,因为一般网络的MTU只有1400多。之所以支持到2000字节是为了省程序内部开的静态buff(静态buff避免malloc提高性能),如果你是开发者,通过重新编译,支持到UDP协议的极限( +mode 0模式允许你发送的数据包大小超过物理接口的MTU而几乎不引起性能损失(而普通的ip分片做不到这点),目前最高支持到2000字节,2000字节已经可以应对任何应用了,因为一般网络的MTU只有1400多。之所以支持到2000字节是为了省程序内部开的静态buff(静态buff避免malloc提高性能),如果你是开发者,通过重新编译,支持到UDP协议的极限( 65507字节)也没问题。 ##### `--report`  选项 @@ -168,13 +168,13 @@ UDPspeeder默认情况下会对每个发出的数据包随机填充和异或一 ##### `-q,--queue-len` 编码器在做FEC前最多积攒多少个数据包,只对mode 0有效。除非是使用下文`V2版如何多倍发包`里面提到的用法,不建议改动。 #### `--fifo` option -用fifo(命名管道)向运行中的程序发送command. 例如`--fifo fifo.file`,可用的command有: +用fifo(命名管道)向运行中的程序发送command。例如`--fifo fifo.file`,可用的command有: ``` -echo fec 19:9 >fifo.file -echo mtu 1100 >fifo.file -echo timeout 5 >fifo.file -echo queue-len 100 >fifo.file -echo mode 0 >fifo.file +echo fec 19:9 > fifo.file +echo mtu 1100 > fifo.file +echo timeout 5 > fifo.file +echo queue-len 100 > fifo.file +echo mode 0 > fifo.file ``` 可以动态改变fec编码器参数。可以从程序的log里看到command是否发送成功。 @@ -182,7 +182,7 @@ echo mode 0 >fifo.file ### 在FEC和多倍发包之间如何选择 -对于游戏,游戏的流量本身不大,延迟很重要,多倍发包是最佳解决方案,多倍发包不会引入额外的延迟。FEC编码器需要先积攒一些数据,才可以做FEC,延迟无法避免;对于多倍发包,没有这个问题,所以没有延迟。 +对于游戏,游戏的流量本身不大,延迟很重要,多倍发包是最佳解决方案,多倍发包不会引入额外的延迟。FEC编码器需要先积攒一些数据,才可以做FEC,延迟无法避免;对于多倍发包,没有这个问题,所以没有延迟。 对于其他日常应用(延迟要求一般),在合理配置的情况下,FEC的效果肯定好过多倍发包。不过需要根据网络的最大丢包来配置FEC参数,才能有稳定的效果。如果配置不当,对于--mode 1可能会完全没有效果;对于--mode 0,可能效果会比不用UDPspeeder还差。 @@ -190,7 +190,7 @@ echo mode 0 >fifo.file ### V2版如何多倍发包 -只要在设置-f参数时把x设置为1,fec算法就退化为多倍发包了。例如-f1:1,表示2倍发包,-f1:2表示3倍发包,以此类推。另外可以加上`--mode 0 -q1`参数,防止fec编码器试图积攒和合并数据,获得最低的延迟。 +只要在设置-f参数时把x设置为1,fec算法就退化为多倍发包了。例如-f1:1,表示2倍发包,-f1:2表示3倍发包,以此类推。另外可以加上`--mode 0 -q1`参数,防止fec编码器试图积攒和合并数据,获得最低的延迟。 2倍发包的完整参数: @@ -215,11 +215,11 @@ echo mode 0 >fifo.file ### 根据CPU处理能力来调整FEC参数 -FEC算法很吃CPU,初次使用建议关注UDPspeeder的CPU占用。如果CPU被打满,可以在冗余度不变的情况下把FEC分组大小调小,否则的话效果可能很差。 +FEC算法很吃CPU,初次使用建议关注UDPspeeder的CPU占用。如果CPU被打满,可以在冗余度不变的情况下把FEC分组大小调小,否则的话效果可能很差。 -比如-f20:10和-f10:5,都是1.5倍的冗余度,而-f20:10的FEC分组大小是30个包,-f10:5的FEC分组大小是15个包。-f20:10更费CPU,但是在一般情况下效果更稳定。把分组调小可以节省CPU。 +比如-f20:10和-f10:5,都是1.5倍的冗余度,而-f20:10的FEC分组大小是30个包,-f10:5的FEC分组大小是15个包。-f20:10更费CPU,但是在一般情况下效果更稳定。把分组调小可以节省CPU。 -另外,fec分组大小不宜过大,否则不但很耗CPU,还有其他副作用,建议x+y<50。 +另外,fec分组大小不宜过大,否则不但很耗CPU,还有其他副作用,建议x+y<50。 ### 改变FEC参数而不断线 @@ -240,13 +240,13 @@ UDPspeeder和BBR/锐速可以配合使用,UDPspeeder工作在IP层负责降低 ### UDPspeeder和Kcptun配合 -UDPspeeder和Kcptun配合,UDPspeeder和Kcptun可以并联也可以串联。 +UDPspeeder和Kcptun配合,UDPspeeder和Kcptun可以并联也可以串联。 -并联的情况下,让kcptun负责加速TCP,UDPspeeder负责加速UDP。见下文的`UDPspeeder + kcptun + $*** 同时加速tcp和udp流量`。 +并联的情况下,让kcptun负责加速TCP,UDPspeeder负责加速UDP。见下文的`UDPspeeder + kcptun + $*** 同时加速tcp和udp流量`。 串联的情况。UDPspeeder的FEC跟Kcptun自带的相比:可以对两个方向设置不同的FEC参数、有一个更省流量的mode 0模式、可以动态改变FEC参数;但是UDPspeeder本身不优化拥塞和重传算法。所以UDPspeeder和Kcptun也可以配合使用,结合两者的优点。 -串联时可以关掉Kcptun的FEC,让UDPspeeder接管FEC功能。这样UDPspeeder工作在UDP层负责降低丢包率,Kcptun工作在应用层用kcp算法负责优化拥塞和重传,能起到和`UDPspeeder+BBR/锐速`类似的效果。 +串联时可以关掉Kcptun的FEC,让UDPspeeder接管FEC功能。这样UDPspeeder工作在UDP层负责降低丢包率,Kcptun工作在应用层用kcp算法负责优化拥塞和重传,能起到和`UDPspeeder+BBR/锐速`类似的效果。 如果发Issue问Kcptun+UDPspeeder相关的问题,一定要说明是并联还是串联。 @@ -268,7 +268,7 @@ UDPspeeder和Kcptun配合,UDPspeeder和Kcptun可以并联也可以串联。 具体配置方法简介: 假设$\*\*\* server监听在在44.55.66.77的443端口(tcp和udp同时)。用kcptun把tcp 443映射到本地的tcp 1234;用UDPspeeder把udp 443的映射到本地的udp 1234。 -然后让$\*\*\* client 去连127.0.0.1:1234就可以了,tcp和udp都被加速了。完整命令: +然后让$\*\*\* client 去连127.0.0.1:1234就可以了,tcp和udp都被加速了。完整命令: ``` run at server side: ./kcp_server -l ":4000" -t "127.0.0.1:443" -mode fast2 @@ -279,7 +279,7 @@ run at client side: ./speederv2 -c -l0.0.0.0:1234 -r44.55.66.77:4001 -f20:10 -k "passwd" ``` -这就是全部的命令了。issue里有很多人困惑于怎么把tcp和udp流量"分开",其实很简单就可以做到。 +这就是全部的命令了。issue里有很多人困惑于怎么把tcp和udp流量"分开",其实很简单就可以做到。 如果只需要加速UDP,不需要加速TCP,可以把kcptun换成其他的任意端口转发方式,比如ncat/socat/ssh tunnel/iptables。 diff --git a/doc/README.zh-cn.v1.md b/doc/README.zh-cn.v1.md index 30e7814..a6d4ad4 100644 --- a/doc/README.zh-cn.v1.md +++ b/doc/README.zh-cn.v1.md @@ -15,7 +15,7 @@ UDP双边加速工具,降低丢包率,配合vpn可以加速任何协议, 每个冗余数据包都是间隔数毫秒(可配置)以后延迟发出的,可以避开中间路由器因为瞬时buffer长度过长而连续丢掉所有副本。 -模拟一定的延迟抖动,这样上层应用计算出来的RTT方差会更大,以等待后续冗余包的到达,不至于发生在冗余包到达之前就触发重传的尴尬。 +模拟一定的延迟抖动,这样上层应用计算出来的RTT方差会更大,以等待后续冗余包的到达,不至于发生在冗余包到达之前就触发重传的尴尬。 #### 适用场景 绝大部分流量不高的情况。程序本身加速udp,但是配合openvpn可以加速任何流量。网络状况不好时,游戏卡得没法玩,或者网页卡得没法打开,使用起来效果最好。对于解决语音通话的断断续续效果也不错。不适合大流量的场景,比如BT下载和在线看视频。 无论从自己使用效果的角度,还是从国际出口带宽占用的角度,都建议不要在大流量环境使用。 @@ -134,7 +134,7 @@ other options: 跟openvpn via kcptun方式的对比: -kcptun在udp层有RS code,也是一种冗余传输,通过openvpn把流量转成tcp,再通过kcptun加速是有一定效果的。但是tcp只支持按序到达。按序到达的意思是,如果你发了1 2 3 4 5 6 ,6个包,如果第一个包丢了,那么必须等第一个包重传成功以后 2 3 4 5 6 才能到达;只要有一个包不到,后续数据包就要一直等待。用tcp承载udp流量会破坏udp的实时性。会造成游戏卡顿更严重。 +kcptun在udp层有RS code,也是一种冗余传输,通过openvpn把流量转成tcp,再通过kcptun加速是有一定效果的。但是tcp只支持按序到达。按序到达的意思是,如果你发了1 2 3 4 5 6,6个包,如果第一个包丢了,那么必须等第一个包重传成功以后 2 3 4 5 6 才能到达;只要有一个包不到,后续数据包就要一直等待。用tcp承载udp流量会破坏udp的实时性。会造成游戏卡顿更严重。 udp协议本身是ip协议加上了端口之后的直接封装,udp继承了ip协议的实时/乱序到达特性,更适合中转vpn。 diff --git a/doc/udpspeeder_openvpn.md b/doc/udpspeeder_openvpn.md index 15e8b65..e27ac8e 100644 --- a/doc/udpspeeder_openvpn.md +++ b/doc/udpspeeder_openvpn.md @@ -39,7 +39,7 @@ mute 20 comp-lzo no -fragment 1200 ##### very important you can turn it up a bit. but,the lower the safer +fragment 1200 ##### very important you can turn it up a bit. but, the lower the safer mssfix 1200 ##### very important sndbuf 2000000 ##### important @@ -79,7 +79,7 @@ mute 20 comp-lzo no -fragment 1200 ##### very important you can turn it up a bit. but,the lower the safer +fragment 1200 ##### very important you can turn it up a bit. but, the lower the safer mssfix 1200 ##### very important sndbuf 2000000 ##### important @@ -88,9 +88,9 @@ txqueuelen 4000 ##### suggested ``` ##### Note: -If you use the `redirect-gateway` option of OpenVPN,you may need to add a route exception for your remote server ip at client side.Otherwise OpenVPN may hijack UDPspeeder 's traffic. +If you use the `redirect-gateway` option of OpenVPN, you may need to add a route exception for your remote server ip at client side.Otherwise OpenVPN may hijack UDPspeeder 's traffic. -For example,depend on your network environment,the command may looks like: +For example, depend on your network environment, the command may looks like: ``` ip route add 44.55.66.77 via 44.55.66.1 ```