Skip to content

Commit 3b4e765

Browse files
committed
doc: update readme
1 parent 6073823 commit 3b4e765

File tree

1 file changed

+52
-37
lines changed

1 file changed

+52
-37
lines changed

README.md

+52-37
Original file line numberDiff line numberDiff line change
@@ -83,65 +83,80 @@ gtun本身只提供流量代理通道,至于哪些流量需要被劫持,**
8383
- 一台公有云服务器,用于部署服务端程序gtund,区域越靠近被加速区域(源站)越好,并且确认gtund监听的端口被打开
8484
- 另外一台可以是公有云服务器,也可以是内网机器,也可以是路由器,用于部署客户端程序gtun,目前gtun只支持linux系统
8585

86-
### 安装运行gtund
87-
gtund需要运行在公有云上,相对比较简单,原则上越靠近需要加速的区域越好
86+
### 安装gtund
87+
gtund部署在美国的AWS上,支持systemd和docker两种方式进行启动
8888

89-
首先生成配置文件,可以下载 [gtund.yaml](https://github.com/ICKelin/gtun/blob/master/etc/gtund.yaml) 进行修改
89+
[release](https://github.com/ICKelin/gtun/releases)里面找到2.0.7版本的产物并进行下载,
90+
91+
```
92+
cd gtund
93+
./install.sh
94+
```
95+
install.sh 会创建gtund的运行目录,并通过systemd把gtund程序拉起。
96+
执行install.sh完成之后,gtund会:
97+
- 监听tcp的3002作为mux协议的服务端口
98+
- 监听udp的3002作为kcp协议的服务端口
99+
- 日志记录在/opt/apps/gtund/logs/gtund.log
100+
101+
gtund的默认配置为,默认情况下不需要作任何的修改即可
90102

91103
```yaml
104+
enable_auth: true
105+
auths:
106+
- access_token: "ICKelin:free"
107+
expired_ath: 0
108+
92109
trace: ":3003"
93110
server:
94111
- listen: ":3002"
95112
scheme: "kcp"
96113

97-
- listen: ":3001"
114+
- listen: ":3002"
98115
scheme: "mux"
99116

100117
log:
101118
days: 5
102119
level: "debug"
103-
path: "gtund.log"
120+
path: "/opt/apps/gtund/logs/gtund.log"
104121

105122
```
106123

107-
大部分情况下,如果您的端口未被占用,不需要修改任何配置
108-
`./gtund -c gtund.yaml`文件即可。
124+
您也可以使用docker-compose来进行安装:
109125

110-
### 安装运行gtun
111-
gtun可以运行在内网,也可以运行在公有云,在本场景当中,gtun会被部署在内网。
126+
```shell
127+
cd gtund
128+
docker-compose up --build -d
129+
```
112130

113-
首先生成配置文件,可以下载 [gtun.yaml](https://github.com/ICKelin/gtun/blob/master/etc/gtun.yaml) 进行修改
131+
执行完之后docker ps 看是否启动成功
114132

115-
```yaml
116-
accelerator:
117-
HK:
118-
routes:
119-
- scheme: "kcp"
120-
server: "gtun.alihk.byc.com:3002"
121-
trace: "gtun.alihk.byc.com:3003"
122-
proxy:
123-
tproxy_tcp: |
124-
{
125-
"read_timeout": 30,
126-
"write_timeout": 30,
127-
"listen_addr": ":8524"
128-
}
129-
tproxy_udp: |
130-
{
131-
"read_timeout": 30,
132-
"write_timeout": 30,
133-
"session_timeout": 30,
134-
"listen_addr": ":8524"
135-
}
136-
log:
137-
days: 5
138-
level: debug
139-
path: gtun.log
133+
### 安装gtun
140134

135+
gtun的安装也类似,在[release](https://github.com/ICKelin/gtun/releases)里面找到2.0.7版本的产物并进行下载,然后在本地linux上进行部署
136+
137+
```shell
138+
cd gtun
139+
export ACCESS_TOKEN="ICKelin:free"
140+
export SERVER_IP="gtund所在的服务器的ip"
141+
./install.sh
142+
```
143+
144+
其中ACCESS_TOKEN为gtund配置的认证的token,SERVER_IP是gtund的公网IP
145+
146+
安装完成之后查看是否有错误日志
147+
148+
```shell
149+
tail -f /opt/apps/gtun/logs/gtun.log
150+
```
151+
152+
同样,你也可以使用docker-compose来安装
153+
154+
```shell
155+
cd gtun
156+
docker-compose up --build -d
141157
```
142-
通常只需要修改server和trace两个字段,value为gtund的的`公网IP:监听端口`即可。
143158

144-
配置完成之后可以启动gtun程序,运行`./gtun -c gtun.yaml`即可启动
159+
执行完成之后docker ps 看是否启动成功
145160

146161
[返回目录](#目录)
147162

0 commit comments

Comments
 (0)