From 06eb377186cab66f1b05c31cc7e73710329c295a Mon Sep 17 00:00:00 2001 From: "zhiyong.luo" <33410675+lazy-luo@users.noreply.github.com> Date: Tue, 19 Apr 2022 12:28:31 +0800 Subject: [PATCH] Update readme.md --- readme.md | 60 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 48 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index 3dad9dd..083341d 100644 --- a/readme.md +++ b/readme.md @@ -47,13 +47,18 @@ * socket 连接池
* 多级任务队列
* ...
-* 附：交互示意图
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/smarGateArch.png)
- +
+ + 附：交互示意图 + +
+
+ ## smarGate有什么主要功能？
* 支持代理穿透
* 官方提供免费的代理服务器（共享带宽，多人共用时比较慢，最佳实践为启用自有代理服务器）
* 如果自己有云服务器（具备公网ip），用户可自定义自己的代理服务器，且在代理服务器上安装proxy_server。所有数据传输走用户配置的代理服务器（为了防止中间人攻击，代理服务器需要用户生成自签名证书）
+ ``` 1、“代理服务器”配置如下（代理服务器必须允许任意端口“入站”连接）： ``` @@ -110,15 +115,32 @@ * 其它内网穿透工具的主推模式，将内网服务直接映射到外网端口
## 使用指南:
-【常用服务配置】
+【常用服务配置】
### 1、下载android app（app-release.apk包含客户端和服务端）支持armv7及arm64 cpu架构
### 2、注册新用户（邀请码必填，为数字，可任意填。ps：如果必填信息未填完整,或包含中文字符，会注册失败）
-![login](https://github.com/lazy-luo/smarGate/blob/master/res/login.png)
-![register](https://github.com/lazy-luo/smarGate/blob/master/res/register.png)
+
+ + 展开图示 + +
+
+
+ ### 3、注册成功后请务必记住返回的服务ID(N) 【重要】：注册成功后务必在1小时内完成首次登录
-![register result](https://github.com/lazy-luo/smarGate/blob/master/res/registerok.png)
+
+ + 展开图示 + +
+
+ ### 4、下载内网服务器适合的服务端版本（目前支持linux-x86-32/64，windows，及linux-arm【树莓派、群晖】,另：Android app自带服务端模式）
### 5、解压服务端压缩包，修改配置文件(conf-proxy.xml):
+
+ + 配置样例 + + ``` @@ -131,17 +153,31 @@ ``` +
+ ### 6、执行服务端命令(参数说明 i:最大接入连接数,o:最大接出连接数,w:最大线程数)
* linux下执行命令：chmod +x proxy_server && nohup ./proxy_server -i1000 -o1000 -w8 >/dev/null &
* windows下执行命令：proxy_server.exe -i1000 -o1000 -w8
* Android 手机/设备：运行app -〉编辑模式下，配置服务端信息 -〉打开“服务端”开关 -〉重启app
* OpenWrt mips设备安装请见：【MIPS linux下正确使用方式】
### 7、使用注册时的用户名/密码登陆手机客户端
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper1.png)
+
+ + 展开图示 + +
+
+ ### 8、在客户端中可以看到上线的服务端，可以在客户端上定义端口反弹规则
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper2.png)
-### 配置中的“远程ip”为“访问点”对应内网中的某台主机ip（localhost或127.0.0.1代表内网server端所在机器本身） -![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper3.png)
+
+ + 展开图示 + +
+配置中的“远程ip”为“访问点”对应内网中的某台主机ip（localhost或127.0.0.1代表内网server端所在机器本身） +
+
+ ### 9、电脑或手机可以直接访问手机客户端设置的服务（如ssh、http等）
## 补充说明:
* 所有版本已经打包了依赖，开箱即用.
@@ -198,7 +234,7 @@ 2、android客户端设置好后让其在后台运行，如果始终保持前台会定时刷新，webview控件空耗电，你懂的;
3、服务端始终保持后台运行，安全放心，只有你自己才能访问；
...使用场景...
- 【家用摄像头P2P直连】
+ 【家用摄像头P2P直连】
## 免责申明
* 请您仔细阅读以下申明，您在使用smarGate工具软件，表明您对以下内容的接受：
1、严禁使用本软件从事计算机黑客以及其他任何危害计算机信息网络安全的行为;