Update readme.md

multi-language support

client/languages/language.js

@@ -0,0 +1,214 @@
+var g_languages = [
+    ["中文"//0
+    ,"确 定"//1
+    ,"取 消"//2
+    ,"刷 新"//3
+    ,"清缓存"//4
+    ,"改密码"//5
+    ,"保 存"//6
+    ,"模式切换"//7
+    ,"删 除"//8
+    ,"登 录"//9
+    ,"注 册"//10
+    ,"返回登录"//11
+    ,"移动网关"//12
+    ,"用户登录"//13
+    ,"用户名"//14
+    ,"密码"//15
+    ,"自动登录"//16
+    ,"用户注册"//17
+    ,"邀请码"//18
+    ,"确认密码"//19
+    ,"姓名"//20
+    ,"联系电话"//21
+    ,"邮箱"//22
+    ,"同意协议"//23
+    ,"必须填写邀请码"//24
+    ,"描述"//25
+    ,"基础信息"//26
+    ,"发送"//27
+    ,"接收"//28
+    ,"总内存"//29
+    ,"已用内存"//30
+    ,"内存峰值"//31
+    ,"状态"//32
+    ,"在线"//33
+    ,"离线"//34
+    ,"系统状态"//35
+    ,"工作线程数"//36
+    ,"空闲线程数"//37
+    ,"最大连接数"//38
+    ,"当前连接数"//39
+    ,"待处理事件"//40
+    ,"检测线程数"//41
+    ,"服务集合"//42
+    ,"本地端口"//43
+    ,"路由指向"//44
+    ,"协议"//45
+    ,"远程IP"//46
+    ,"远程端口"//47
+    ,"服务端"//48
+    ,"修改配置"//49
+    ,"官方代理"//50
+    ,"访问点配置"//51
+    ,"访问点序号"//52
+    ,"访问点名称"//53
+    ,"访问点描述"//54
+    ,"协商端口号"//55
+    ,"输入小于64的数字..."//56
+    ,"输入节点名..."//57
+    ,"输入简短描述..."//58
+    ,"协商端口号默认不指定..."//59
+    ,"必须输入访问点序号，且为<64的整数"//60
+    ,"更改密码"//61
+    ,"旧密码"//62
+    ,"新密码"//63
+    ,"恭喜您：注册请求成功，请务必妥善保管你的服务ID"//64
+    ,"登录失败，请验证输入的用户名密码！"//65
+    ,"登录中..."//66
+    ,"注册失败，请确认信息填写无误！"//67
+    ,"密码修改失败！！"//68
+    ,"请等待..."//69
+    ,"注册中..."//70
+    ,"必须输入原密码"//71
+    ,"密码不能为空"//72
+    ,"新密码不能和原密码相同"//73
+    ,"确认密码不一致"//74
+    ,"访问点名称不能为空，且长度<64"//75
+    ,"访问点简要描述不能为空，且长度<64"//76
+    ,"必须填写邀请码"//77
+    ,"必须填写用户名"//78
+    ,"必须设置密码"//79
+    ,"必须设置确认密码，且确保与密码一致"//80
+    ,"必须填写昵称"//81
+    ,"你真的要删除当前配置的代理点吗？"//82
+    ,"正在自动登录，请稍后..."//83
+    ,"网络不可用，请确认网络设置"//84
+    ,"端口"//85
+    ,"服务端模式"//86
+    ,"访问点"//87
+    ,"待检测"//88
+    ,"连接检测中..."//89
+    ,"旧版本"//90
+    ,"登录失败！用户不存在或密码错误"//91
+    ,"密码修改成功！请妥善保管您的密"//92
+    ,"密码修改成功！下次登录需重新输入新密码"//93
+    ,"注册失败！邀请码有误"//94
+    ,"密码修改失败，请稍后再试"//95
+    ,"转发配置错误[本地端口需大于1024]"//96
+    ,"转发端口配置错误[需小于65536]"//97
+    ,"远程端口配置错误，范围[1-65535]"//98
+    ,"转发配置错误[端口冲突]"//99
+    ,"转发配置错误[未知错误]"//100
+    ,"配置修改成功！将在下次重启时生效"//101
+    ,"移动网关将保持提供服务"//102
+    ,"服务启动时间"//103
+    ,"暴露服务集"//104
+    ],
+    ["English"
+    , "OK" //1
+    , "Cancel" //2
+    , "Refresh" //3
+    , "Clear" //4
+    , "Chpass" //5
+    , "Save" //6
+    , "Chmode" //7
+    , "Delete" //8
+    , "Login" //9
+    , "Register" //10
+    , "Back to login" //11
+    , "SmarGate" //12
+    , "User login" //13
+    , "User name" //14
+    , "Password" //15
+    , "Auto login" //16
+    , "User registration" //17
+    , "Invitation code" //18
+    , "Confirm password" //19
+    , "Name" //20
+    , "Contact number" //21
+    , "Mailbox" //22
+    , "Agreement of consent" //23
+    , "Invitation code must be filled in" //24
+    , "Desc" //25
+    , "Info" //26
+    , "SND" //27
+    , "RX" //28
+    , "Tot-mem" //29
+    , "Usage" //30
+    , "Max-usage" //31
+    , "Status" //32
+    , "Online" //33
+    , "Offline" //34
+    , "Summery" //35
+    , "Tot-threads" //36
+    , "Idle threads" //37
+    , "Max-sockets" //38
+    , "Connections" //39
+    , "Pending event" //40
+    , "Event threads" //41
+    , "Services" //42
+    , "Local port" //43
+    , "Routing to" //44
+    , "Protocol" //45
+    , "Peer IP" //46
+    , "Peer port" //47
+    , "Server" //48
+    , "Configure" //49
+    , "Agent" //50
+    , "Endpoint configuration" // 51
+    , "Endpoint IDX"//52
+    , "Endpoint name" // 53
+    , "Endpoint Desc" // 54
+    , "Negotiation port" //55
+    , "Enter a number less than 64..." //56
+    , "Enter node name..." //57
+    , "Enter a short description..." //58
+    , "No need specified by default..." //59
+    , "The access point number must be entered and is an integer of <64" //60
+    , "Change password" //61
+    , "Old password" //62
+    , "New password" //63
+    , "Congratulations: registration request is successful. Please keep your service ID properly" //64
+    , "Login failed. Please verify the user name password you entered!"// 65
+    , "Logging in..." //66
+    , "Registration failed. Please confirm that the information is filled in correctly!"// 67
+    , "Password modification failed!!"// 68
+    , "Please wait..." //69
+    , "Registered..." //70
+    , "Must enter original password" //71
+    , "Password cannot be empty" //72
+    , "New password cannot be the same as the original password" //73
+    , "Confirm password is inconsistent" //74
+    , "Endpoint name cannot be empty and length is <64" //75
+    , "Endpoint brief description cannot be empty and length is <64" //76
+    , "Invitation code must be filled in" //77
+    , "User name must be filled in" //78
+    , "Password must be set" //79
+    , "Confirm password must be set and be sure to be consistent with password" //80
+    , "Must fill in nickname" //81
+    , "Do you really want to delete the currently configured proxy point?"// 82
+    , "Logging in automatically, please wait..." //83
+    , "Network not available, please confirm network settings "//84
+    , "Port" //85
+    , "Server mode" //86
+    , "EP" // 87 Endpoint
+    , "Waiting for detection" //88
+    , "Connection detection..." //89
+    , "Old version" //90
+    , "Login failed! User does not exist or password error "//91
+    , "Password modified successfully! Please keep your secret in good condition "//92
+    , "Password modified successfully! The next login requires a new password to be re entered "//93
+    , "Registration failed! Invitation code error "//94
+    , "Password modification failed. Please try again later "//95
+    , "Forwarding configuration error [local port needs to be greater than 1024]" //96
+    , "Forward port configuration error [less than 65536]" //97
+    , "Remote port configuration error, range [1-65535]" //98
+    , "Forward configuration error [port conflict]" //99
+    , "Forward configuration error [unknown error]" //100
+    , "Configuration modification succeeded! Will take effect on the next reboot "//101
+    , "The SmarGate will remain in service" // 102
+    , "Service start time" // 103
+    , "Exposed services"//104
+    ]
+  ];

readme.md

@@ -1,19 +1,24 @@
 # 中文 | [English](https://github.com/lazy-luo/smarGate/blob/master/README_en.md)
-# 快速概览
+# 快速概览<a href=https://github.com/lazy-luo/smarGate/wiki/快速上手手册>【快速上手手册】</a><br>
+* 平台适配，支持linux、windows、macos、android、（tob，小型机：hp-unix、solaris、AIX）<br>
+* cpu架构，支持x86、arm、mips（tob：alpha、PowerPC、SPRAC）<br>
 * 注重安全，“内网”到“内网”的穿透，无需映射任何端口到外网，不更改任何防火墙配置<br>
-* 注重带宽，”4G手机+v6宽带“采用P2P方式访问内网服务（v4支持NAT1-3穿透）<br>
+* 注重带宽，”4G手机+v6宽带“采用P2P方式访问内网服务（基于TCP协议，v4支持NAT1-3穿透）<br>
 * 注重节约，无需购买vps、无需公网IP；家中淘汰Android手机可做服务器<br>
 * 注重可靠，随用随有，可7*24不间断服务，且不受UDP协议Qos之苦<br>
 * 注重可控，客户端一点配置，且随时随地控制服务开启/关闭<br>
 * 注重环保，免安装，体量小巧（mini版1MB左右） allinone，高性能且资源占用最少<br>
 * 注重便携，无论工作或是度假，不管在任何地方，只要手机有网络，一切尽在掌控<br>
 * ......如果这都是你想要的！请耐心继续往下看；如果你还想要...请提issue，【更新历史】也有看头哦<br>
-# 移动网关
-* 无需公网IP，提供内网穿透能力，通过加密隧道，能安全的将内网服务暴露出来. <br>
-* 支持p2p通讯（基于TCP协议，p2p通道可用时显示为绿色）<br>
-* 支持自定义代理服务器 <br>
 * 免费，测试稳定后考虑开源. <br>
 * 包含一个android客户端和需内网安装的服务端.<br>
+
+# APP端配置（必须）--- 无法正常使用典型情况
+* 必须配置“允许后台运行”权限，否则切后台即被系统断连
+* 必须配置“休眠时始终保持网络连接”，否则一旦休眠则被系统断连
+* 可以配置“允许自启动”权限，否则Android服务端模式下无法开机启动（v0.30版本）
+* 可以配置“麦克风”权限，否则Android服务端无法提供语音监听功能（v0.30版本）
+* 注意：SG不提供到国外IP的数据转发
 ## smarGate是什么？<br>
 #### 官方命名为“移动网关”，通过手机客户端将位于内网的服务端网络进行按需暴露，核心引擎采用c++实现。<br>
 #### “移动网关”是用户私有网关，所有共享访问入口都在客户端，不是类似其它穿透工具主推的面向域名的公共访问入口。打个比方：smarGate是将防盗门随身携带，其它穿透产品是将防盗门放到公共场所，额...虽然需要钥匙，但有种职业叫开锁匠<br>
@@ -39,13 +44,18 @@
 	* socket 连接池<br>
 	* 多级任务队列 <br>
 	* ...<br>
-* 附：交互示意图<br>
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/smarGateArch.png)<br>
-
+<details>
+<summary>
+	<mark><font size=6 color=darkred>附：交互示意图</font></mark>
+</summary>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/smarGateArch.png" /><br>
+</details>
+	
 ## smarGate有什么主要功能？<br>
 * 支持代理穿透<br>
   * 官方提供免费的代理服务器（共享带宽，多人共用时比较慢，最佳实践为启用自有代理服务器）<br>
   * <I>如果自己有云服务器（具备公网ip），用户可自定义自己的代理服务器，且在代理服务器上安装proxy_server。所有数据传输走用户配置的代理服务器（为了防止中间人攻击，代理服务器需要用户生成自签名证书）</I> <br>
+
 ```  
   1、“代理服务器”配置如下（代理服务器必须允许任意端口“入站”连接）：
 ```
@@ -87,19 +97,44 @@
   * 使用TCP协议进行p2p穿透，提升安全性<br>
   * 不是所有的网络都支持p2p，取决于两端NAT类型
   * v0.14以上版本，直接支持ipv6，且能提供防火墙穿透
+  * P2P测试结论：一端是NAT4，另一端是NAT3或NAT4时无法打通<br>
+注：NAT1-〉Full Cone ， NAT2-〉Restricted Cone ， NAT3-〉Port Restricted Cone ， NAT4-〉Symmetric<br>
+  <table>
+	<th>服务端 NAT</th><th>客户端 NAT</th><th>P2P成功</th>
+	<tr><td>NAT1-3</td><td>NAT1-3</td><td>YES</td></tr>
+	<tr><td>NAT1-2</td><td>NAT4</td><td>YES</td></tr>
+	<tr><td>NAT4</td><td>NAT1-2</td><td>YES</td></tr>
+	<tr><td>NAT4</td><td>NAT3-4</td><td>NO</td></tr>
+	<tr><td>NAT3-4</td><td>NAT4</td><td>NO</td></tr>
+  </table>
+  
 * 支持外网发布（有违安全设计理念，免费版不提供支持）<br>
   * 其它内网穿透工具的主推模式，将内网服务直接映射到外网端口<br>
 
 ## 使用指南:<br>
-<a href=https://github.com/lazy-luo/smarGate/wiki/常用服务穿透配置>【常用服务配置】</a><br>
-### 1、下载android app（app-release.apk包含客户端和服务端）支持armv7及arm64 cpu架构<br>
-### 2、注册新用户（邀请码必填，为数字，可任意填。ps：如果必填信息未填完整,或包含中文字符，会注册失败）<br>
-![login](https://github.com/lazy-luo/smarGate/blob/master/res/login.png)<br>
-![register](https://github.com/lazy-luo/smarGate/blob/master/res/register.png)<br>
-### 3、注册成功后请务必记住返回的服务ID(N) 【重要】：注册成功后务必在1小时内完成首次登录<br>
-![register result](https://github.com/lazy-luo/smarGate/blob/master/res/registerok.png)<br>
-### 4、下载内网服务器适合的服务端版本（目前支持linux-x86-32/64，windows，及linux-arm【树莓派、群晖】,另：Android app自带服务端模式）<br>
-### 5、解压服务端压缩包，修改配置文件(conf-proxy.xml):<br>
+<a href="https://www.baidu.com/s?wd=smargate%20内网穿透">使用实践-度娘</a><br><br>
+<a href="https://www.google.com/search?q=smargate+内网穿透">使用实践-google</a>
+### 1、下载app && 注册新用户
+* 下载android app（app-release.apk包含客户端和服务端）支持armv7及arm64 cpu架构<br>
+* 注册新用户（邀请码必填，为数字，可任意填。ps：如果必填信息未填完整,或包含中文字符，会注册失败）<br>
+* 注册成功后请务必记住返回的服务ID(N) 【重要】：注册成功后务必在1小时内完成首次登录<br>
+<details>
+<summary>
+	<mark><font size=5 color=darkred>展开图示</font></mark>
+</summary>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/login.png" /><br>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/register.png" /><br>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/registerok.png" /><br>
+</details>
+
+### 2、下载服务端 && 配置
+* 下载内网服务器适合的服务端版本（目前支持linux-x86-32/64，windows，及linux-arm【树莓派、群晖】,另：Android app自带服务端模式）<br>
+* 解压服务端压缩包，修改配置文件(conf-proxy.xml):<br>
+<details>	
+<summary>
+	<mark><font size=5 color=darkred>配置样例</font></mark>
+</summary>
+	
 ```
   <?xml version="1.0" encoding="GBK"?>
     <app-config code="PROXY" name="proxy-server">
@@ -112,17 +147,25 @@
     </moudle-parameter>
   </app-config>
 ```
-### 6、执行服务端命令(参数说明 i:最大接入连接数,o:最大接出连接数,w:最大线程数)<br>
+</details>
+
+### 3、运行内网服务端(命令参数说明 i:最大接入连接数,o:最大接出连接数,w:最大线程数)<br>
 * linux下执行命令：chmod +x proxy_server && nohup ./proxy_server -i1000 -o1000 -w8 >/dev/null & <br>
 * windows下执行命令：proxy_server.exe -i1000 -o1000 -w8 <br>
 * Android 手机/设备：运行app -〉编辑模式下，配置服务端信息 -〉打开“服务端”开关 -〉重启app <br>
-### 7、使用注册时的用户名/密码登陆手机客户端<br>
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper1.png)<br>
-### 8、在客户端中可以看到上线的服务端，可以在客户端上定义端口反弹规则<br>
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper2.png)<br>
-### 配置中的“远程ip”为“访问点”对应内网中的某台主机ip（localhost或127.0.0.1代表内网server端所在机器本身）
-![operator](https://github.com/lazy-luo/smarGate/blob/master/res/oper3.png)<br>
-### 9、电脑或手机可以直接访问手机客户端设置的服务（如ssh、http等）<br>
+* OpenWrt mips设备安装请见：<a href=https://github.com/lazy-luo/smarGate/issues/65>【MIPS linux下正确使用方式】</a><br>
+### 4、登陆手机app && 配置端口映射 <a href="https://github.com/lazy-luo/smarGate/wiki/常用服务穿透配置">【常用服务配置】</a><br>
+* 在客户端中可以看到上线的服务端（“访问点”），可以在客户端上定义端口映射规则<br>
+<details>
+<summary>
+	<mark><font size=5 color=darkred>展开图示</font></mark>
+</summary>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/oper2.png" /><br>
+<b>配置中的“远程ip”为“访问点”对应内网中的某台主机ip（localhost或127.0.0.1代表内网server端所在机器本身）</b>
+<img src="https://github.com/lazy-luo/smarGate/blob/master/res/oper3.png" /><br>
+</details>
+
+### 5、电脑或手机可以直接访问手机客户端设置的服务（如ssh、http等）<br>
 ## 补充说明:<br>
 * 所有版本已经打包了依赖，开箱即用.<br>
 * 系统将自动清除30天以上未使用的“僵尸账号”.<br>
@@ -177,7 +220,8 @@
   1、android客户端设置为“自动登录”，免除每次输入用户名/密码的麻烦;<br> 
   2、android客户端设置好后让其在后台运行，如果始终保持前台会定时刷新，webview控件空耗电，你懂的;<br>
   3、服务端始终保持后台运行，安全放心，只有你自己才能访问；<br>
-  ...待补充...<br>
+  ...使用场景...<br>
+  <a href="https://cloud.tencent.com/developer/article/1926888">【家用摄像头P2P直连】</a><br>
 ## 免责申明<br>  
 * 请您仔细阅读以下申明，您在使用smarGate工具软件，表明您对以下内容的接受：<br> 
   1、严禁使用本软件从事计算机黑客以及其他任何危害计算机信息网络安全的行为;<br> 
@@ -198,6 +242,36 @@ ps：捐赠建议附上注册用户名<br>
 	<mark><font size=5 color=darkred>更新历史</font></mark>
 </summary>
 	
+### 2022-05-04: <br>
+1、支持riscv32/64架构，编译时同mips架构使用musl库进行链接<br>
+2、优化网络传输层<br>
+3、版本暂保持不变<br>
+	
+### 2022-02-07更新到v0.30.4: <br>
+1、提供mips64el支持<br>
+2、增加app端系统图标显示 <br>
+3、其它优化<br>
+	
+### 2021-11-06更新到v0.30.3: <br>
+1、修复app端内存占用只显示jvm不包含native的BUG<br>
+2、优化网络引擎，提升高并发下的稳定性及公平性 <br>
+	
+### 2021-10-17更新到v0.30.2: <br>
+1、自定义代理支持ssl验证<br>
+2、网络P2P情况下，支持配置成ssl隧道（ **要求服务端必须配置证书** ）<br>
+```
+<app-parameter>
+  <ssl-tunnel-required value="first" /><!-- 取值有3个：none、first、only -->
+  ...
+</app-parameter>
+```
+3、其他优化<br>
+	
+### 2021-09-24更新到v0.30: <br>
+1、提供了Android服务端开机自启动支持(仅服务端模式，且需要自行手动授权)<br>
+2、网络P2P情况下，Android服务端支持实时音频（麦克风权限需要自行手动授权，必须打开SG界面才能录音）<br>
+3、其他优化<br>
+
 ### 2021-05-03更新到v0.29.2: <br>
 1、修复Android高版本无法退出问题<br>
 2、优化网络:修复了可能带来网络延迟的BUG，进一步提升网络传输速度<br>