mirror of
https://github.com/ehang-io/nps.git
synced 2025-09-02 11:56:53 +00:00
很多修改
This commit is contained in:
刘河
124
README.md
124
README.md
@@ -1,7 +1,7 @@
|
||||
# easyProxy
|
||||
  
|
||||
|
||||
easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**，可支持任何tcp、udp上层协议（访问内网网站、本地支付接口调试、ssh访问、远程桌面，内网dns解析等等……），此外还**支持内网http代理、内网socks5代理**，可实现在非内网环境下如同使用vpn一样访问内网资源和设备的效果，同时**支持socks5验证，snnapy压缩（节省带宽和流量）、站点保护、加密传输、多路复用、host修改、自定义header**。
|
||||
easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**，可支持任何tcp、udp上层协议（访问内网网站、本地支付接口调试、ssh访问、远程桌面，内网dns解析等等……），此外还**支持内网http代理、内网socks5代理**，可实现在非内网环境下如同使用vpn一样访问内网资源和设备的效果。
|
||||
|
||||
目前市面上提供类似服务的有花生壳、TeamView、GoToMyCloud等等，但要使用第三方的公网服务器就必须为第三方付费，并且这些服务都有各种各样的限制，此外，由于数据包会流经第三方，因此对数据安全也是一大隐患。
|
||||
|
||||
@@ -38,33 +38,47 @@ easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**
|
||||
- [x] 支持一个服务端，多个客户端模式
|
||||
- [x] host修改支持
|
||||
- [x] 自定义设置header支持
|
||||
- [x] 流量统计
|
||||
- [x] 自动义404页面
|
||||
- [x] 热更新支持
|
||||
|
||||
## 目录
|
||||
|
||||
1. [安装](#安装)
|
||||
2. [web管理模式](#web管理模式)（多隧道时推荐）
|
||||
3. [tcp隧道模式](#tcp隧道模式)
|
||||
4. [udp隧道模式](#udp隧道模式)
|
||||
5. [socks5代理模式](#socks5代理模式)
|
||||
6. [http代理模式](#http代理模式)
|
||||
7. [数据压缩支持](#数据压缩支持)
|
||||
8. [站点密码保护](#站点保护)
|
||||
9. [加密传输](#加密传输)
|
||||
10. [TCP多路复用](#多路复用)
|
||||
11. [host修改](#host修改)
|
||||
12. [自定义header](#自定义header)
|
||||
13. [获取用户真实ip](#获取用户真实ip)
|
||||
* [安装](#安装)
|
||||
* [编译安装](#源码安装)
|
||||
* [release安装](#release安装)
|
||||
* [web管理](#web管理模式)（多隧道时推荐）
|
||||
* [启动](#启动)
|
||||
* [配置文件说明](#服务端配置文件)
|
||||
* 单隧道模式及介绍
|
||||
* [tcp隧道模式](#tcp隧道模式)
|
||||
* [udp隧道模式](#udp隧道模式)
|
||||
* [socks5代理模式](#socks5代理模式)
|
||||
* [http代理模式](#http代理模式)
|
||||
|
||||
* [相关功能](#相关功能)
|
||||
* [数据压缩支持](#数据压缩支持)
|
||||
* [站点密码保护](#站点保护)
|
||||
* [加密传输](#加密传输)
|
||||
* [TCP多路复用](#多路复用)
|
||||
* [host修改](#host修改)
|
||||
* [自定义header](#自定义header)
|
||||
* [获取用户真实ip](#获取用户真实ip)
|
||||
* [热更新支持](#热更新支持)
|
||||
* [客户端地址显示](#客户端地址显示)
|
||||
* [自定义404页面](#404页面配置)
|
||||
* [流量统计](#流量统计)
|
||||
* [连接池](#连接池)
|
||||
|
||||
## 安装
|
||||
|
||||
1. release安装
|
||||
### release安装
|
||||
> https://github.com/cnlh/easyProxy/releases
|
||||
|
||||
下载对应的系统版本即可，服务端和客户端是单独的，go语言开发，无需任何第三方依赖
|
||||
|
||||
2. 源码安装
|
||||
- 安装源码
|
||||
### 源码安装
|
||||
- 安装源码(另有snappy、beego包)
|
||||
> go get github.com/cnlh/easyProxy
|
||||
- 编译
|
||||
> go build cmd/server/proxy_server.go
|
||||
@@ -89,35 +103,7 @@ tcpport | 服务端客户端通信端口
|
||||
|
||||
**提示：使用web模式时，服务端执行文件必须在项目根目录，否则无法正确加载配置文件**
|
||||
|
||||
### 使用
|
||||
|
||||
|
||||
|
||||
**有两种模式：**
|
||||
|
||||
1、单客户端模式，所有的隧道流量均从这个单客户端转发。
|
||||
|
||||
|
||||
- 服务端
|
||||
|
||||
```
|
||||
./proxy_server -vkey=DKibZF5TXvic1g3kY
|
||||
```
|
||||
名称 | 含义
|
||||
---|---
|
||||
vkey | 验证密钥
|
||||
|
||||
|
||||
- 客户端
|
||||
|
||||
```
|
||||
./proxy_client -server=ip:port -vkey=DKibZF5TXvic1g3kY
|
||||
```
|
||||
- 配置
|
||||
|
||||
进入web界面，公网ip:web界面端口（默认8080），密码默认为123
|
||||
|
||||
2、多客户端模式，不同的隧道流量均从不同的客户端转发。
|
||||
### 启动
|
||||
|
||||
|
||||
- 服务端
|
||||
@@ -125,10 +111,11 @@ vkey | 验证密钥
|
||||
```
|
||||
./proxy_server
|
||||
```
|
||||
名称 | 含义
|
||||
---|---
|
||||
mode | 运行模式
|
||||
|
||||
- 客户端
|
||||
```
|
||||
./proxy_server -server=ip:port -vkey=web界面中显示的
|
||||
```
|
||||
|
||||
进入web管理界面，有详细的命令
|
||||
|
||||
@@ -316,30 +303,31 @@ httpport | http代理连接端口
|
||||
配置HTTP代理即可，ip为外网服务器ip，端口为httpport，即可在外网环境访问内网啦！
|
||||
```
|
||||
|
||||
## 数据压缩支持
|
||||
## 相关功能
|
||||
|
||||
### 数据压缩支持
|
||||
|
||||
由于是内网穿透，内网客户端与服务端之间的隧道存在大量的数据交换，为节省流量，加快传输速度，由此本程序支持SNNAPY形式的压缩。
|
||||
|
||||
|
||||
- 所有模式均支持数据压缩，可以与加密同时使用
|
||||
|
||||
|
||||
- 开启此功能会增加cpu和内存消耗
|
||||
- 在server端加上参数 -compress=snappy（或在web管理中设置）
|
||||
```
|
||||
-compress=snappy
|
||||
```
|
||||
|
||||
## 加密传输
|
||||
### 加密传输
|
||||
|
||||
如果公司内网防火墙对外网访问进行了流量识别与屏蔽，例如禁止了ssh协议等，通过设置 配置文件，将服务端与客户端之间的通信内容加密传输，将会有效防止流量被拦截。
|
||||
|
||||
|
||||
- 开启此功能会增加cpu和内存消耗
|
||||
- 在server端加上参数 -crypt=true（或在web管理中设置）
|
||||
```
|
||||
-crypt=true
|
||||
```
|
||||
|
||||
## 多路复用
|
||||
### 多路复用
|
||||
|
||||
客户端和服务器端之间的连接支持多路复用，不再需要为每一个用户请求创建一个连接，使连接建立的延迟降低，并且避免了大量文件描述符的占用。
|
||||
|
||||
@@ -351,7 +339,7 @@ httpport | http代理连接端口
|
||||
```
|
||||
|
||||
|
||||
## 站点保护
|
||||
### 站点保护
|
||||
由于所有客户端共用一个 http 服务端口，任何知道你的域名和 url 的人都能访问到你部署在内网的 web 服务，但是在某些场景下需要确保只有限定的用户才能访问。
|
||||
|
||||
easyProxy支持通过 HTTP Basic Auth 来保护你的 web 服务，使用户需要通过用户名和密码才能访问到你的服务。
|
||||
@@ -361,25 +349,37 @@ easyProxy支持通过 HTTP Basic Auth 来保护你的 web 服务，使用户需
|
||||
-u=user -p=password
|
||||
```
|
||||
|
||||
web管理中也可配置
|
||||
- web管理中也可配置
|
||||
|
||||
## host修改
|
||||
### host修改
|
||||
|
||||
|
||||
通常情况下本代理不会修改转发的任何数据。但有一些后端服务会根据 http 请求 header 中的 host 字段来展现不同的网站，例如 nginx 的虚拟主机服务，启用 host-header 的修改功能可以动态修改 http 请求中的 host 字段。该功能仅限于域名代理模式。
|
||||
|
||||
**使用方法：在web管理中设置**
|
||||
|
||||
## 自定义header
|
||||
### 自定义header
|
||||
|
||||
支持对header进行新增或者修改，以配合服务的需要
|
||||
|
||||
## 获取用户真实ip
|
||||
### 获取用户真实ip
|
||||
|
||||
目前只有域名模式的代理支持这一功能，可以通过用户请求的 header 中的 X-Forwarded-For 和 X-Real-IP 来获取用户真实 IP。
|
||||
|
||||
**本代理前会在每一个请求中添加了这两个 header。**
|
||||
|
||||
### 热更新支持
|
||||
在web管理中的修改将实时使用，无需重启客户端或者服务端
|
||||
|
||||
### 客户端地址显示
|
||||
在web管理中将显示客户端的连接地址
|
||||
|
||||
### 404页面配置
|
||||
支持域名解析模式的自定义404页面，修改/web/static/page/error.html中内容即可，暂不支持静态文件等内容
|
||||
|
||||
### 流量统计
|
||||
可统计显示每个代理使用的流量，由于压缩和加密等原因，会和实际环境中的略有差异
|
||||
|
||||
### 连接池
|
||||
easyProxy会预先和后端服务建立起指定数量的连接，每次接收到用户请求后，会从连接池中取出一个连接和用户连接关联起来，避免了等待与后端服务建立连接时间。
|
||||
|
||||
## 操作系统支持
|
||||
支持Windows、Linux、MacOSX等，无第三方依赖库。
|
||||
|
||||
Reference in New Issue
Block a user