mirror of https://github.com/ehang-io/nps
Update README.md
parent
95e2db7a38
commit
b220b5801c
39
README.md
39
README.md
|
@ -3,21 +3,33 @@
|
||||||
|
|
||||||
支持客户端与服务端连接中断自动重连,多路传输,大大的提高请求处理速度,go语言编写,无第三方依赖,经过测试内存占用小,普通场景下,仅占用10m内存。
|
支持客户端与服务端连接中断自动重连,多路传输,大大的提高请求处理速度,go语言编写,无第三方依赖,经过测试内存占用小,普通场景下,仅占用10m内存。
|
||||||
|
|
||||||
|
水平很有限,不足指出请大家指出
|
||||||
|
|
||||||
|
## 背景
|
||||||
|
1. 我有一个小程序的需求,但是小程序的数据源必须从内网才能抓取到,但是又苦于内网服务器没有公网ip,所以只能内网穿透了。用了一段时间ngrok做内网穿透,可能由于功能比较强大,配置起来挺麻烦的,加之开源版有内存的泄漏,很是闹心。正好最近在看go相关的东西,所以做了一款代理服务器,功能比较简单,用于内网穿透最为合适。----> [http代理请求](#http代理请求)
|
||||||
|
|
||||||
|
2. 想在外网通过ssh连接内网的机器,或者做云服务器到内网服务器端口的映射备---->[tcp隧道模式](#tcp隧道模式)
|
||||||
|
|
||||||
|
3. 在外网如同使用内网vpn一样访问内网资源或者设备----> [sock5代理模式](#sock5代理模式)
|
||||||
|
## 特点
|
||||||
|
- [x] 支持gzip压缩,减小流量消耗
|
||||||
|
- [x] 支持多站点配置,兼容多个内网网站
|
||||||
|
- [x] 断线自动重连
|
||||||
|
- [x] 支持多路传输,提高并发
|
||||||
|
- [x] 跨站自动匹配替换
|
||||||
|
- [x] 支持tcp隧道,提升访问效率
|
||||||
|
- [x] 支持内网穿透sock5代理,达到在非内网环境下访问内网的效果
|
||||||
|
- [x] 专注内网穿透
|
||||||
|
|
||||||
## 目录
|
## 目录
|
||||||
|
|
||||||
1. [背景](#背景)
|
1. [安装](#安装)
|
||||||
2. [安装](#安装)
|
|
||||||
2. [http代理请求](#http代理请求)
|
2. [http代理请求](#http代理请求)
|
||||||
3. [tcp隧道模式](#tcp隧道模式)
|
3. [tcp隧道模式](#tcp隧道模式)
|
||||||
4. [sock5代理模式](#sock5代理模式)
|
4. [sock5代理模式](#sock5代理模式)
|
||||||
5. [操作系统支持](#操作系统支持)
|
5. [操作系统支持](#操作系统支持)
|
||||||
|
|
||||||
## 背景
|
|
||||||
我有一个小程序的需求,但是小程序的数据源必须从内网才能抓取到,但是又苦于内网服务器没有公网ip,所以只能内网穿透了。
|
|
||||||
|
|
||||||
用了一段时间ngrok做内网穿透,可能由于功能比较强大,配置起来挺麻烦的,加之开源版有内存的泄漏,很是闹心。
|
|
||||||
|
|
||||||
正好最近在看go相关的东西,所以做了一款代理服务器,功能比较简单,用于内网穿透最为合适。
|
|
||||||
|
|
||||||
## 安装
|
## 安装
|
||||||
|
|
||||||
|
@ -32,19 +44,11 @@
|
||||||
- 编译(无第三方模块)
|
- 编译(无第三方模块)
|
||||||
> go build
|
> go build
|
||||||
|
|
||||||
## http代理请求请求
|
## http代理请求
|
||||||
|
|
||||||
### 场景及原理
|
### 场景及原理
|
||||||
较为适用于http,也就是web站点的穿透,服务端与客户端之间建立连接,服务端收到http请求后,将请求发送到客户端,客户端再执行这个请求,并将结果返回给服务端,服务端收到后再返回给用户。
|
较为适用于http,也就是web站点的穿透,服务端与客户端之间建立连接,服务端收到http请求后,将请求发送到客户端,客户端再执行这个请求,并将结果返回给服务端,服务端收到后再返回给用户。
|
||||||
|
|
||||||
### 特点
|
|
||||||
- [x] 支持gzip压缩,减小流量消耗
|
|
||||||
- [x] 支持多站点配置
|
|
||||||
- [x] 断线自动重连
|
|
||||||
- [x] 支持多路传输,提高并发
|
|
||||||
- [x] 跨站自动匹配替换
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 使用
|
### 使用
|
||||||
- 服务端
|
- 服务端
|
||||||
|
@ -208,7 +212,7 @@ tcp | 服务端与客户端通信端口
|
||||||
vkey | 验证密钥
|
vkey | 验证密钥
|
||||||
num | 服务端与客户端通信连接数
|
num | 服务端与客户端通信连接数
|
||||||
|
|
||||||
## sock5模式
|
## sock5代理模式
|
||||||
|
|
||||||
### 场景及原理
|
### 场景及原理
|
||||||
主要用于sock5代理,也就是和ss类似,不过是代理内网。使用此模式时,可在非内网环境下配置本机的sock5代理(服务器ip、sock5代理端口),即可实现sock5代理,达到访问内网的网站的效果。
|
主要用于sock5代理,也就是和ss类似,不过是代理内网。使用此模式时,可在非内网环境下配置本机的sock5代理(服务器ip、sock5代理端口),即可实现sock5代理,达到访问内网的网站的效果。
|
||||||
|
@ -227,7 +231,6 @@ mode | 运行模式(client、server不写默认client)
|
||||||
vkey | 验证密钥
|
vkey | 验证密钥
|
||||||
tcpport | 服务端与客户端通信端口
|
tcpport | 服务端与客户端通信端口
|
||||||
httpport | 代理的http端口(与nginx配合使用)
|
httpport | 代理的http端口(与nginx配合使用)
|
||||||
target | 目标地址,格式如上
|
|
||||||
|
|
||||||
- 客户端
|
- 客户端
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue