diff --git a/README.md b/README.md index 98a4563..c92096b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # easyProxy -easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**,可支持任何tcp、udp上层协议(访问内网网站、本地支付接口调试、ssh访问、远程桌面,内网dns解析等等……),此外还**支持内网http代理、内网socks5代理**,可实现在非内网环境下如同使用vpn一样访问内网资源和设备的效果,同时**支持socks5验证,gzip、snnapy压缩(节省带宽和流量)**。 +easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**,可支持任何tcp、udp上层协议(访问内网网站、本地支付接口调试、ssh访问、远程桌面,内网dns解析等等……),此外还**支持内网http代理、内网socks5代理**,可实现在非内网环境下如同使用vpn一样访问内网资源和设备的效果,同时**支持socks5验证,snnapy压缩(节省带宽和流量)、站点保护、加密传输**。 目前市面上提供类似服务的有花生壳、TeamView、GoToMyCloud等等,但要使用第三方的公网服务器就必须为第三方付费,并且这些服务都有各种各样的限制,此外,由于数据包会流经第三方,因此对数据安全也是一大隐患。 @@ -22,7 +22,7 @@ easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透** 6. 搭建一个内网穿透ss,在外网如同使用内网vpn一样访问内网资源或者设备----> [socks5代理模式](#socks5代理模式) ## 特点 -- [x] 支持gzip、snappy压缩,减小传输过程流量消耗 +- [x] 支持snappy压缩,减小传输过程流量消耗 - [x] 支持多站点配置,兼容多个内网网站,可处理相互之间的跳转包含关系 - [x] 断线自动重连 - [x] 支持多路传输,提高并发 @@ -32,22 +32,31 @@ easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透** - [x] 支持http代理 - [x] 支持内网穿透sock5代理,配合proxifer可达到vpn的效果,在外网访问内网资源或者设备,同时可以设置用户名和密码验证 - [x] 强大的web管理界面,可方便的设置的和管理隧道 +- [x] 支持站点密码保护 +<<<<<<< Updated upstream +======= +- [x] 支持加密传输 +>>>>>>> Stashed changes - [x] 支持同时开多条tcp、udp隧道等等,且只需要开一个客户端和服务端 - [x] 支持一个服务端,多个客户端模式 ## 目录 1. [安装](#安装) -2. [web管理模式](#web管理模式)(推荐) +2. [web管理模式](#web管理模式)(多隧道时推荐) 3. [tcp隧道模式](#tcp隧道模式) 4. [udp隧道模式](#udp隧道模式) 5. [http反向代理请求](#http代理请求) -6. [socks5代理模式](#sock5代理模式) +6. [socks5代理模式](#socks5代理模式) 7. [http代理模式](#http代理模式) 8. [数据压缩支持](#数据压缩支持) -9. [操作系统支持](#操作系统支持) - - +<<<<<<< Updated upstream +9. [站点保护](#站点保护) +======= +9. [站点密码保护](#站点保护) +11. [加密传输](#加密传输) +>>>>>>> Stashed changes +10. [配置文件说明](#配置文件) ## 安装 @@ -67,7 +76,7 @@ easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透** ![image](https://github.com/cnlh/easyProxy/blob/master/image/web2.png?raw=true) ### 介绍 -可在网页上配置和管理各个tcp、udp隧道、内网站点代理等等,功能极为强大,操作也非常方便。[演示地址](http://123.206.77.88:8081) 密码:123 +可在网页上配置和管理各个tcp、udp隧道、内网站点代理等等,功能极为强大,操作也非常方便。 ### 使用 **有两种模式:** @@ -114,15 +123,10 @@ tcpport | 服务端与客户端通信端口 - 配置 -进入web界面,公网ip:web界面端口(默认8080),密码为123 +进入web界面,公网ip:web界面端口(默认8080),密码默认为123 + -### 配置文件/conf/app.conf -名称 | 含义 ----|--- -httpport | web管理端口 -password | web界面管理密码 -hostPort | 域名代理模式监听端口 ## tcp隧道模式 @@ -345,7 +349,10 @@ u | 验证的用户名 p | 验证的密码 **说明**:用户名和密码验证模式,仅部分socks5客户端支持,例如proxifer。 -如需验证,在服务端命令后加上 + +默认验证的用户名和密码为/conf/app.conf中的用户名和密码 + +如需不同,可在服务端命令后加上,将会覆盖/conf/app.conf中的配置 ``` -u=user -p=password ``` @@ -406,25 +413,77 @@ httpport | http代理连接端口 ## 数据压缩支持 ### 场景及原理 -由于是内网穿透,内网客户端与服务端之间的隧道存在大量的数据交换,为节省流量,加快传输速度,由此本程序支持GZIP、SNNAPY两种形式的压缩,两者差异请自行选择。 +由于是内网穿透,内网客户端与服务端之间的隧道存在大量的数据交换,为节省流量,加快传输速度,由此本程序支持SNNAPY形式的压缩。 ### 注意点 -- 所有模式均支持数据压缩 +- 所有模式均支持数据压缩,可以与加密同时使用 ### 如何使用 -**GZIP压缩** +**snappy压缩** -- 在server端加上参数 -compress=gzip,例如在TCP隧道模式 +- 在server端加上参数 -compress=snappy,例如在TCP隧道模式 ``` -./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80 -compress=gzip +./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80 -compress=snappy ``` -**SNAPPY压缩** +## 加密传输 -将参数修改为snappy即可 +如果公司内网防火墙对外网访问进行了流量识别与屏蔽,例如禁止了ssh协议等,通过设置 配置文件,将服务端与客户端之间的通信内容加密传输,将会有效防止流量被拦截。 + +### 如何使用 + + +- 在server端加上参数 -crypt=1(或在web管理中设置),例如在TCP隧道模式 +``` +./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80 -crypt=1 +``` + +**注意:** 优先级:命令行或者web管理设置>配置文件 + + +## 站点保护 +由于所有客户端共用一个 http 服务端口,任何知道你的域名和 url 的人都能访问到你部署在内网的 web 服务,但是在某些场景下需要确保只有限定的用户才能访问。 + +easyProxy支持通过 HTTP Basic Auth 来保护你的 web 服务,使用户需要通过用户名和密码才能访问到你的服务。 + +该功能目前可以在 域名代理模式、http代理请求模式、http代理模式 中使用,需要在/conf/app.conf或者命令行或者webg管理中设置,请按照自己选择的使用方式设置则可。 + +**注意:** 优先级:命令行或者web管理设置>配置文件,为空则表示无需验证 + + + +## 配置文件 +- /conf/app.conf + +名称 | 含义 +---|--- +httpport | web管理端口 +password | web界面管理密码 +hostPort | 域名代理模式监听端口 +auth.user | 验证用户名(socks5、http代理、http代理请求、域名代理模式) +auth.password | 验证密码(socks5、http代理、http代理请求、域名代理模式) + +## 站点保护 +由于所有客户端共用一个 http 服务端口,任何知道你的域名和 url 的人都能访问到你部署在内网的 web 服务,但是在某些场景下需要确保只有限定的用户才能访问。 + +easyProxy支持通过 HTTP Basic Auth 来保护你的 web 服务,使用户需要通过用户名和密码才能访问到你的服务。 + +该功能目前可以在 域名代理模式、http代理请求模式、http代理模式 中使用,需要在/conf/app.conf中设置。 + +**注意:** web管理中如果设置了用户名和密码则会覆盖配置文件中的用户名和密码 + +## 配置文件 +/conf/app.conf +名称 | 含义 +---|--- +httpport | web管理端口 +password | web界面管理密码 +hostPort | 域名代理模式监听端口 +auth.user | 验证用户名(socks5、http代理、http代理请求、域名代理模式) +auth.password | 验证密码(socks5、http代理、http代理请求、域名代理模式) ## 操作系统支持 支持Windows、Linux、MacOSX等,无第三方依赖库。