merge dev

Author: ICKelin

.github/workflows/docker-image.yml

@@ -15,4 +15,4 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Build the Docker image
-      run: ./build_image.sh
+      run: ./docker_build.sh

.github/workflows/go.yml

@@ -22,5 +22,5 @@ jobs:
         go-version: 1.19
 
     - name: Build
-      run: ./build_exec.sh
+      run: ./build.sh
 

.gitignore

@@ -12,4 +12,6 @@ research
 *.tar.gz
 
 docker-build/gtun/gtun*
-docker-build/gtund/gtund
+docker-build/gtund/gtund
+release
+images

README-EN.md

@@ -13,27 +13,18 @@
 <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
 </a>
 
-gtun是一款开源的ip代理加速软件，通过`tproxy`技术实现流量劫持，`quic`和`kcp`等协议优化广域网传输，gtun提供一个基础通道，所有加入`ipset`的ip，出口，入口流量都会被gtun进行拦截并代理到指定出口。
-
+gtun是一款开源的ip代理加速软件，目前只支持linux，通过`tproxy`技术实现流量劫持，`quic`和`kcp`等协议优化广域网传输，gtun提供一个基础通道，所有加入`ipset`的ip的流量都会被gtun进行拦截并代理到指定出口。
 gtun支持多线路配置，可以同时对美国，日本，欧洲目的网络进行加速访问。您可以结合dnsmasq来使用，将需要配置加速的域名解析结果加入ipset，从而实现域名加速。
 
 [![](https://res.cloudinary.com/marcomontalbano/image/upload/v1686622903/video_to_markdown/images/youtube--pxv02e5EXPE-c05b58ac6eb4c4700831b2b3070cd403.jpg)](https://www.youtube.com/watch?v=pxv02e5EXPE "")
 
-**使用场景**
-
-- SaaS软件加速，加速访问Salesforce，offce365等产品
-- 云服务器加速，加速访问海外服务器，跳板机，提升操作流畅度
-- 直播加速，tiktok海外直播加速，抖音直播加速
-- 游戏加速，结合专线网络和路由盒子实现游戏加速盒
-
-gtun是一个完整的加速器，**目前只支持linux**
-
-同时我们也基于gtun开发了收费版本，对标阿里云的全球应用加速，ucloud的pathX等产品的功能，只是会更加灵活，支持私有化部署，独立部署，可以下沉到办公室，如果您感兴趣，可以访问[我们的网站](https://www.beyondnetwork.net)进行免费免费体验。
+同时我们也基于gtun开发了收费版本，对标阿里云的全球应用加速，ucloud的pathX等产品的功能，只是会更加灵活，支持私有化部署，独立部署，可以部署到公有云，数据中心和软路由，如果您感兴趣，可以访问[我们的网站](https://www.beyondnetwork.net)进行免费免费体验。
 
 关于项目有任何问题需要咨询，可以[联系作者](#关于作者)进行交流
 
 ## 目录
 - [介绍](#gtun)
+- [应用场景](#应用场景)
 - [功能特性](#功能特性)
 - [技术原理](#技术原理)
 - [安装部署](#安装部署)
@@ -42,10 +33,24 @@ gtun是一个完整的加速器，**目前只支持linux**
   - [安装运行gtun](#安装运行gtun)
   - [配置加速ip](#配置加速ip)
   - [加速效果测试](#加速效果)
-- [应用场景](#应用场景)
+- [用法玩法]()
+  - [基础用法: 基于gtun+ipset实现ip代理加速和分流](doc/基础用法:基于gtun+ipset实现ip代理加速和分流.md)
+  - [基础用法: 基于gtun+dnsmasq实现域名代理加速和分流](doc/基础用法:基于gtun+dnsmasq实现域名代理加速和分流.md)
+  - [基础用法: openwrt搭载gtun打造加速软路由，连接Wi-Fi即可畅游网络](doc/基础用法:openwrt搭载gtun打造加速软路由，连接Wi-Fi即可畅游网络.md)
+  - [基础用法: 基于gtun实现公有云访问外部加速](doc/基础用法:基于gtun实现公有云访问外部加速.md)
+  - [玩转N1盒子：基于gtun实现的tiktok加速路由](doc/玩转N1盒子:基于gtun实现的tiktok加速路由.md)
+  - [玩转N1盒子：基于gtun实现的游戏加速盒](doc/玩转N1盒子:基于gtun实现的游戏加速盒.md)
 - [有问题怎么办](#有问题怎么办)
 - [关于作者](#关于作者)
 
+## 应用场景
+
+- SaaS软件加速，加速访问Salesforce，offce365等产品
+- 云服务器加速，加速访问海外服务器，跳板机，提升操作流畅度
+- 直播加速，tiktok海外直播加速，抖音直播加速
+- 游戏加速，结合专线网络和路由盒子实现游戏加速盒
+- 云服务器出口加速网关，加速整个公有云内网访问外网的流量
+
 ## 功能特性
 
 - 纯应用层实现，不存在overlay网络，支持tcp和udp协议以及运行在其上的所有七层协议
@@ -64,9 +69,9 @@ gtun是一款ip正向代理软件，包含代理客户端gtun和服务端gtund
 
 gtun最主要的功能是流量代理，gtun经过三个版本的演变，最初基于tun网卡的vpn技术，然后优化到dnat技术，再到目前的tproxy技术，现已逐步趋于稳定。
 
-gtun本身只提供流量代理通道，至于哪些流量需要被劫持，这个是由使用者定义的，使用者最终只需要将被代理的IP加入到`ipset`当中，那么该ipset的ip就会被代理
+gtun本身只提供流量代理通道，至于哪些流量需要被劫持，**这个是由使用者定义的**，使用者最终只需要将被代理的IP加入到`ipset`当中，那么该ipset的ip就会被代理
 
-为了实现更加快速的代理，gtun考虑集成`kcp`或者`quic`等基于UDP实现的可靠性传输协议，以避免长链路tcp丢包严重触发拥塞控制机制，降低传输效率。
+为了实现更加快速的代理，gtun考虑集成`kcp`或者`quic`等基于UDP实现的可靠性传输协议，同时接入FEC，实时选路等机制，以避免长链路tcp丢包严重触发拥塞控制机制，降低传输效率。
 
 [返回目录](#目录)
 
@@ -76,87 +81,110 @@ gtun本身只提供流量代理通道，至于哪些流量需要被劫持，这
 ### 前期准备
 
 - 一台公有云服务器，用于部署服务端程序gtund，区域越靠近被加速区域（源站）越好，并且确认gtund监听的端口被打开
-- 另外一台可以是公有云服务器，也可以是内网机器，用于部署客户端程序gtun，目前gtun只支持linux系统。
+- 另外一台可以是公有云服务器，也可以是内网机器，也可以是路由器，用于部署客户端程序gtun，目前gtun只支持linux系统
 
 ### 安装运行gtund
-gtund需要运行在公有云上，相对比较简单，原则上越靠近源站越好。
+gtund部署在美国的AWS上，支持systemd和docker两种方式进行启动。
+
+在[release](https://github.com/ICKelin/gtun/releases)里面找到2.0.7版本的产物并进行下载，
+
+```
+cd gtund
+./install.sh
+```
+install.sh 会创建gtund的运行目录，并通过systemd把gtund程序拉起。
+执行install.sh完成之后，gtund会：
+- 监听tcp的3002作为mux协议的服务端口
+- 监听udp的3002作为kcp协议的服务端口
+- 日志记录在/opt/apps/gtund/logs/gtund.log
 
-首先生成配置文件，可以下载 [gtund.yaml](https://github.com/ICKelin/gtun/blob/master/etc/gtund.yaml) 进行修改
+gtund的默认配置为，默认情况下不需要作任何的修改即可
 
 ```yaml
+enable_auth: true
+auths:
+  - access_token: "ICKelin:free"
+    expired_ath: 0
+
 trace: ":3003"
 server:
   - listen: ":3002"
-    authKey: "rewrite with your auth key"
     scheme: "kcp"
 
+  - listen: ":3002"
+    scheme: "mux"
+
 log:
   days: 5
   level: "debug"
-  path: "gtund.log"
+  path: "/opt/apps/gtund/logs/gtund.log"
+
 ```
 
-大部分情况下，如果您的端口未被占用，不需要修改任何配置
-`./gtund -c gtund.yaml`文件即可。
+您也可以使用docker-compose来进行安装：
 
-### 安装运行gtun
-gtun可以运行在内网，也可以运行在公有云，在本场景当中，gtun会被部署在内网。
+```shell
+cd gtund
+docker-compose up --build -d
+```
 
-首先生成配置文件，可以下载 [gtun.yaml](https://github.com/ICKelin/gtun/blob/master/etc/gtun.yaml) 进行修改
+执行完之后docker ps 看是否启动成功
 
-```yaml
-settings:
-  US:
-    # 代理ip文件，可以是本地文件，也可以是网络文件，一行是一个IP或者cidr
-    proxy_file: "https://www.ipdeny.com/ipblocks/data/countries/us.zone"
-    route:
-      # 拨测地址，需要修改US_SERVER_IP和US_SERVER_TRACE_PORT，对应gtund的公网IP和端口
-      - trace_addr: ${US_SERVER_IP}:${US_SERVER_TRACE_PORT}
-        scheme: "kcp"
-        # 服务端地址，修改为对应gtund的IP和端口
-        addr: ${US_SERVER_IP}:${US_SERVER_PORT}
-        auth_key: "rewrite with your auth key"
-    proxy:
-      # 代理插件配置
-      "tproxy_tcp": |
-        {
-          "read_timeout": 30,
-          "write_timeout": 30,
-          "listen_addr": ":8524",
-          "rate_limit": 50,
-          "region": "US"
-        }
-      "tproxy_udp": |
-        {
-          "read_timeout": 30,
-          "write_timeout": 30,
-          "session_timeout": 30,
-          "listen_addr": ":8524",
-          "rate_limit": 50,
-          "region": "US"
-        }
-log:
-  days: 5
-  level: Debug
-  path: gtun.log
+### 安装运行gtun
 
-http_server:
-  listen_addr: ":9001"
+gtun的安装也类似，在[release](https://github.com/ICKelin/gtun/releases)里面找到2.0.7版本的产物并进行下载，然后在本地linux上进行部署
+
+```shell
+cd gtun
+export ACCESS_TOKEN="ICKelin:free"
+export SERVER_IP="gtund所在的服务器的ip"
+./install.sh
 ```
 
-配置完成之后可以启动gtun程序，运行`./gtun -c gtun.yaml`即可启动。
+其中ACCESS_TOKEN为gtund配置的认证的token，SERVER_IP是gtund的公网IP
+
+安装完成之后查看是否有错误日志
 
-gtund启动时，会自动设置 iptables规则和路由表，并将需要加速的ip加入ipset当中，如果ip量比较大，启动时间会稍微长一些。
+同样，你也可以使用docker-compose来安装
+
+```shell
+cd gtun
+docker-compose up --build -d
+```
+
+执行完成之后docker ps 看是否启动成功。
 
 [返回目录](#目录)
 
 ### 配置加速ip
-目前支持两种方式配置IP：
 
-- 基于接口的方式，我们提供HTTP接口进行动态增删IP，目前正在开发页面配置动态管理加速的IP，应用，域名，敬请期待。
-- 使用命令手动配置，手动将ip加入到ipset当中
+在上述过程中，启动了gtun和gtund程序，但是并未添加任何需要加速的信息，那么gtun如何进行加速呢？需要额外手动配置加速ip，并将该ip的tcp流量全部转发至127.0.0.1:8524端口，udp流量全部转发至127.0.0.1:8524∂端口。
+
+这个过程是通过ipset和路由来配置的。以1.1.1.1为例
+
+第一步，创建ipset，并将1.1.1.1加入其中
+```
+ipset create GTUN-US hash:net
+ipset add GTUN-US 1.1.1.1
+```
+
+第二步，创建iptables规则，匹配目的ip为GTUN-US这个ipset内部的ip，然后做tproxy操作，将流量重定向到本地8524和8524端口
+
+```
+iptables -t mangle -I PREROUTING -p tcp -m set --match-set GTUN-US dst -j TPROXY --tproxy-mark 1/1 --on-port 8524
+iptables -t mangle -I PREROUTING -p udp -m set --match-set GTUN-US dst -j TPROXY --tproxy-mark 1/1 --on-port 8524
+iptables -t mangle -I OUTPUT -m set --match-set GTUN-US dst -j MARK --set-mark 1
+```
+
+第三步，添加路由表
+
+```
+ip rule add fwmark 1 lookup 100
+ip ro add local default dev lo table 100
+```
+
+至此所有配置都已经完成，后续需要新增代理ip，只使用以下命令将ip加入GTUN-US这个ipset当中即可，现在可以先尝试测试1.1.1.1这个ip的代理。
 
-接下来以命令配置的方式进行配置，以`1.1.1.1`为例，只需要将`1.1.1.1`加入其中ipset当中`ipset add GTUN-US 1.1.1.1`即可。
 ```
 root@raspberrypi:/home/pi# nslookup www.google.com 1.1.1.1
 Server:		1.1.1.1
@@ -211,13 +239,6 @@ root@raspberrypi:/home/pi# wget http://speedtest.atlanta.linode.com/100MB-atlant
 
 [返回目录](#目录)
 
-## 应用场景
-
-- IP加速，可用于ip，子网加速
-- 域名，站点加速，需要使用dnsmasq或者nginx/openresty等组件实现
-- k8s集群网络代理，ip加速的一个子集，可代理访问k8s的service，pod网段
-- 全球应用加速
-
 ## 有问题怎么办
 
 - [wiki](https://github.com/ICKelin/gtun/wiki)

README.md

@@ -0,0 +1,24 @@
+rm -r release
+mkdir -p release
+mkdir -p release/gtun/etc
+mkdir -p release/gtund/etc
+
+git log -n 5 > release/gtun/ChangeLog
+git log -n 5 > release/gtund/ChangeLog
+
+DIR=`pwd`
+
+cd src/gtun
+GOOS=linux go build -o gtun
+mv gtun $DIR/release/gtun/
+cd $DIR
+cp scripts/install_gtun.sh release/gtun/install.sh
+cp -r scripts release/gtun/scripts
+cp -r etc/gtun/* release/gtun/etc
+
+cd src/gtund
+GOOS=linux GOARCH=amd64 go build -o gtund
+mv gtund $DIR/release/gtund/
+cd $DIR
+cp scripts/install_gtund.sh release/gtund/install.sh
+cp -r etc/gtund/* release/gtund/etc