From 6b7bc8e8769f33a406bc820f17ecb40e2f9811a8 Mon Sep 17 00:00:00 2001 From: zhao xin Date: Sat, 31 Oct 2020 23:08:41 +0800 Subject: [PATCH] Update README_EN.md --- README_EN.md | 100 ++------------------------------------------------- 1 file changed, 2 insertions(+), 98 deletions(-) diff --git a/README_EN.md b/README_EN.md index 21591ae..e9c7fba 100644 --- a/README_EN.md +++ b/README_EN.md @@ -9,14 +9,9 @@ [](https://github.com/esrrhs/pingtunnel/actions) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a200bca59d1b4ca7a9c2cdb564508b47)](https://www.codacy.com/manual/esrrhs/pingtunnel?utm_source=github.com&utm_medium=referral&utm_content=esrrhs/pingtunnel&utm_campaign=Badge_Grade) -Pingtunnel is a tool that advertises tcp/udp/sock5 traffic as icmp traffic for forwarding. Used to break through the network blockade, or to bypass the WIFI network login verification, or speed up network transmission speed on some networks. - +Pingtunnel is a tool that advertises tcp/udp/sock5 traffic as icmp traffic for forwarding. ![image](network.jpg) -# Why use this -* TCP and UDP traffic of some servers are banned and can be bypassed by pingtunnel. -* In some occasions, such as schools, cafes, and airports, login jump authentication is required, which can be bypassed by pingtunnel. -* In some networks, TCP/UDP transmission is very slow. You can speed up the network through pingtunnel. # Use ### Install server * First prepare a server with a public IP, such as EC2 on AWS, assuming the domain name or public IP is www.yourserver.com @@ -34,8 +29,7 @@ echo 1 > /proc/sys/net/ipv4/icmp_echo_ignore_all * Download the gui version of qt from [pingtunnel-qt](https://github.com/esrrhs/pingtunnel-qt) * Double-click the exe to run, modify the server (such as www.yourserver.com), listen port (such as 1080), tick sock5, other settings can be default, and then click *GO* * Everything is normal, there will be a ping value on the interface, and then you can click X to hide it in the status bar -* Set the browser's sock5 proxy to 127.0.0.1:1080, If you do not connect to the Internet, a socks version not supported error log appears, indicating that the browser's proxy is not a socks5 proxy.If it prompts a non-secure connection, it means there is a problem with dns. Check "Use socks5 proxy DNS query" on the browser, or refer to [yellowdns](https://github.com/esrrhs/yellowdns) - +* Set the browser's sock5 proxy to 127.0.0.1:1080, If you do not connect to the Internet, a socks version not supported error log appears, indicating that the browser's proxy is not a socks5 proxy.If it prompts a non-secure connection, it means there is a problem with dns. Check "Use socks5 proxy DNS query" on the browser. ![image](qtrun.jpg) ### Install the client (recommended for high play) @@ -67,101 +61,11 @@ docker run --name pingtunnel-client -d --restart = always -p 1080: 1080 esrrhs / # Test download the centos image [centos mirror](http://mirrors.ocf.berkeley.edu/centos/8.2.2004/isos/x86_64/CentOS-8.2.2004-x86_64-dvd1.iso) - -the results of direct wget, shadowsocks wget, kcptun wget, and pingtunnel wget are as follows. - | | wget | shaowsocks | kcptun | pingtunnel | |--------------|----------|------------|------------|------------| | AlibabaCloud | 26.6KB/s | 31.8KB/s | 606KB/s |5.64MB/s| -the acceleration effect is basically **200 times**. - # Download cmd: https://github.com/esrrhs/pingtunnel/releases QT GUI: https://github.com/esrrhs/pingtunnel-qt - -# Stargazers over time - -[![Stargazers over time](https://starchart.cc/esrrhs/pingtunnel.svg)](https://starchart.cc/esrrhs/pingtunnel) - -# Other -#### Router use -refer to the use of [yellowsocks](https://github.com/esrrhs/yellowsocks) -#### Mobile phone use -It is recommended to use other protocols, such as phone client-> pingtunnel client-> pingtunnel server-> phone server. or use [spp-shadowsocks-plugin-android](https://github.com/esrrhs/spp-shadowsocks-plugin-android) - -# Usage - By forging ping, the tcp/udp/sock5 traffic is forwarded to the destination server through the remote server. Used to break certain operators to block TCP/UDP traffic. - - Usage: - - // server - pingtunnel -type server - - // client, Forward udp - pingtunnel -type client -l LOCAL_IP:4455 -s SERVER_IP -t SERVER_IP:4455 - - // client, Forward tcp - pingtunnel -type client -l LOCAL_IP:4455 -s SERVER_IP -t SERVER_IP:4455 -tcp 1 - - // client, Forward sock5, implicitly open tcp, so no target server is needed - pingtunnel -type client -l LOCAL_IP:4455 -s SERVER_IP -sock5 1 - - -type client or server - - server param: - - -key Set password, default 0 - - -nolog Do not write log files, only print standard output, default 0 is off - - -noprint Do not print standard output, default 0 is off - - -loglevel log level, default is info - - -maxconn the max num of connections, default 0 is no limit - - -maxprt max process thread in server, default 100 - - -maxprb max process thread's buffer in server, default 1000 - - -conntt The timeout period for the server to initiate a connection to the destination address. The default is 1000ms. - - client param: - - -l Local address, traffic sent to this port will be forwarded to the server - - -s The address of the server, the traffic will be forwarded to this server through the tunnel - - -t Destination address forwarded by the remote server, traffic will be forwarded to this address - - -timeout The time when the local record connection timed out, in seconds, 60 seconds by default - - -key Set password, default 0 - - -tcp Set the switch to forward tcp, the default is 0 - - -tcp_bs Tcp send and receive buffer size, default 1MB - - -tcp_mw The maximum window of tcp, the default is 10000 - - -tcp_rst Tcp timeout resend time, default 400ms - - -tcp_gz Tcp will compress data when the packet exceeds this size, 0 means no compression, default 0 - - -tcp_stat Print tcp connection statistic, default 0 is off - - -nolog Do not write log files, only print standard output, default 0 is off - - -noprint Do not print standard output, default 0 is off - - -loglevel log level, default is info - - -sock5 Turn on sock5 forwarding, default 0 is off - - -profile Enable performance detection on the specified port. The default 0 is not enabled. - - -s5filter Set the forwarding filter in the sock5 mode. The default is full forwarding. For example, setting the CN indicates that the Chinese address is not forwarded. - - -s5ftfile The data file in sock5 filter mode, the default reading of the current directory GeoLite2-Country.mmdb