mirror of
https://github.com/cnlh/nps.git
synced 2024-04-21 12:31:54 +00:00
279 lines
6.8 KiB
Markdown
279 lines
6.8 KiB
Markdown
# easyProxy
|
|
轻量级、高性能http代理服务器，主要应用于内网穿透。支持三种模式，**http代理请求**、**tcp隧道模式**、**sock5代理模式**，可根据自身需求进行选择。
|
|
|
|
支持客户端与服务端连接中断自动重连，多路传输，大大的提高请求处理速度，go语言编写，无第三方依赖，经过测试内存占用小，普通场景下，仅占用10m内存。
|
|
|
|
水平很有限，不足指出请大家指出
|
|
|
|
## 背景
|
|
1. 我有一个小程序的需求，但是小程序的数据源必须从内网才能抓取到，但是又苦于内网服务器没有公网ip，所以只能内网穿透了。----> [http代理请求](#http代理请求)
|
|
|
|
2. 想在外网通过ssh连接内网的机器，或者做云服务器到内网服务器端口的映射备---->[tcp隧道模式](#tcp隧道模式)
|
|
|
|
3. 在外网如同使用内网vpn一样访问内网资源或者设备----> [sock5代理模式](#sock5代理模式)
|
|
## 特点
|
|
- [x] 支持gzip压缩,减小流量消耗
|
|
- [x] 支持多站点配置,兼容多个内网网站
|
|
- [x] 断线自动重连
|
|
- [x] 支持多路传输,提高并发
|
|
- [x] 跨站自动匹配替换
|
|
- [x] 支持tcp隧道,提升访问效率
|
|
- [x] 支持内网穿透sock5代理，达到在非内网环境下访问内网的效果
|
|
- [x] 专注内网穿透
|
|
|
|
## 目录
|
|
|
|
1. [安装](#安装)
|
|
2. [http代理请求](#http代理请求)
|
|
3. [tcp隧道模式](#tcp隧道模式)
|
|
4. [sock5代理模式](#sock5代理模式)
|
|
5. [操作系统支持](#操作系统支持)
|
|
|
|
|
|
|
|
## 安装
|
|
|
|
1. release安装
|
|
> https://github.com/cnlh/easyProxy/releases
|
|
|
|
下载对应的系统版本即可（目前linux和windows只编译了64位的），服务端和客户端共用一个程序，go语言开发，无需任何第三方依赖
|
|
|
|
2. 源码安装
|
|
- 安装源码
|
|
> go get github.com/cnlh/easyProxy
|
|
- 编译（无第三方模块）
|
|
> go build
|
|
|
|
## http代理请求
|
|
|
|
### 场景及原理
|
|
较为适用于http，也就是web站点的穿透，服务端与客户端之间建立连接，服务端收到http请求后，将请求发送到客户端，客户端再执行这个请求，并将结果返回给服务端，服务端收到后再返回给用户。
|
|
|
|
|
|
### 使用
|
|
- 服务端
|
|
|
|
```
|
|
./easyProxy -mode httpServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
|
|
```
|
|
|
|
名称 | 含义
|
|
---|---
|
|
mode | 运行模式(client、server不写默认client)
|
|
vkey | 验证密钥
|
|
tcpport | 服务端与客户端通信端口
|
|
httpport | 代理的http端口（与nginx配合使用）
|
|
|
|
- 客户端
|
|
|
|
```
|
|
建立配置文件 config.json
|
|
```
|
|
|
|
|
|
```
|
|
./easyProxy -config config.json
|
|
```
|
|
|
|
|
|
名称 | 含义
|
|
---|---
|
|
config | 配置文件路径
|
|
### 配置文件config.json
|
|
|
|
```
|
|
{
|
|
"Server": {
|
|
"ip": "123.206.77.88",
|
|
"tcp": 8284,
|
|
"vkey": "DKibZF5TXvic1g3kY",
|
|
"num": 10
|
|
},
|
|
"SiteList": [
|
|
{
|
|
"host": "server1.ourcauc.com",
|
|
"url": "10.1.50.203",
|
|
"port": 80
|
|
},
|
|
{
|
|
"host": "server2.ourcauc.com",
|
|
"url": "10.1.50.196",
|
|
"port": 4000
|
|
}
|
|
],
|
|
"Replace": 0
|
|
}
|
|
```
|
|
名称 | 含义
|
|
---|---
|
|
ip | 服务端ip地址
|
|
tcp | 服务端与客户端通信端口
|
|
vkey | 验证密钥
|
|
num | 服务端与客户端通信连接数
|
|
SiteList | 本地解析的域名列表
|
|
host | 域名地址
|
|
url | 内网代理的地址
|
|
port | 内网代理的地址对应的端口
|
|
Replace | 是否自动匹配替换[（查看场景）](https://github.com/cnlh/easyProxy/issues/1)
|
|
|
|
|
|
### nginx代理配置示例
|
|
```
|
|
upstream nodejs {
|
|
server 127.0.0.1:8024;
|
|
keepalive 64;
|
|
}
|
|
server {
|
|
listen 80;
|
|
server_name server1.ourcauc.com server2.ourcauc.com;
|
|
location / {
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header Host $http_host:8024;
|
|
proxy_set_header X-Nginx-Proxy true;
|
|
proxy_set_header Connection "";
|
|
proxy_pass http://nodejs;
|
|
}
|
|
}
|
|
```
|
|
## 域名配置示例
|
|
> -server1 A 123.206.77.88
|
|
|
|
> -server2 A 123.206.77.88
|
|
|
|
### 跨站自动匹配替换说明
|
|
|
|
例如，访问：server1.ourcauc.com，该页面里面有一个超链接为10.1.50.196:4000,将根据配置文件自动该将url替换为server2.ourcauc.com，以达到跨站也可访问的效果，但需要提前在配置文件中配置这些站点。
|
|
|
|
如需开启，请加配置文件Replace值设置为1
|
|
>注意：开启可能导致不应该被替换的内容被替换，请谨慎开启
|
|
|
|
### 二级域名示范
|
|
|
|
[二级域名](https://github.com/cnlh/easyProxy/wiki/%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B)
|
|
|
|
## tcp隧道模式
|
|
|
|
### 场景及原理
|
|
较为适用于处理tcp连接，例如ssh，同时也适用于http等，访问服务端的8024端口相当于访问内网目标ip的目标端口，构成如下所示的隧道。
|
|
|
|
服务端<----->客户端<----->目标地址
|
|
|
|
|
|
### 使用
|
|
- 服务端
|
|
|
|
```
|
|
./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80
|
|
```
|
|
|
|
名称 | 含义
|
|
---|---
|
|
mode | 运行模式(client、server不写默认client)
|
|
vkey | 验证密钥
|
|
tcpport | 服务端与客户端通信端口
|
|
httpport | 代理的http端口（与nginx配合使用）
|
|
target | 目标地址，格式如上
|
|
|
|
- 客户端
|
|
|
|
```
|
|
建立配置文件 config.json
|
|
```
|
|
|
|
|
|
```
|
|
./easyProxy -config config.json
|
|
```
|
|
|
|
|
|
名称 | 含义
|
|
---|---
|
|
config | 配置文件路径
|
|
### 配置文件config.json
|
|
|
|
|
|
|
|
|
|
```
|
|
{
|
|
"Server": {
|
|
"ip": "123.206.77.88",
|
|
"tcp": 8284,
|
|
"vkey": "DKibZF5TXvic1g3kY",
|
|
"num": 10
|
|
}
|
|
}
|
|
```
|
|
名称 | 含义
|
|
---|---
|
|
ip | 服务端ip地址
|
|
tcp | 服务端与客户端通信端口
|
|
vkey | 验证密钥
|
|
num | 服务端与客户端通信连接数
|
|
|
|
## sock5代理模式
|
|
|
|
### 场景及原理
|
|
主要用于sock5代理，也就是和ss类似，不过是代理内网。使用此模式时，可在非内网环境下配置本机的sock5代理（服务器ip、sock5代理端口），即可实现sock5代理，达到访问内网的网站的效果。
|
|
|
|
|
|
### 使用
|
|
- 服务端
|
|
|
|
```
|
|
./easyProxy -mode sock5Server -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
|
|
```
|
|
|
|
名称 | 含义
|
|
---|---
|
|
mode | 运行模式(client、server不写默认client)
|
|
vkey | 验证密钥
|
|
tcpport | 服务端与客户端通信端口
|
|
httpport | 代理的http端口（与nginx配合使用）
|
|
|
|
- 客户端
|
|
|
|
```
|
|
建立配置文件 config.json
|
|
```
|
|
|
|
|
|
```
|
|
./easyProxy -config config.json
|
|
```
|
|
|
|
- 需要使用内网代理的机器
|
|
|
|
|
|
```
|
|
配置sock5即可，ip为外网服务器ip，端口为httpport，即可在外网环境使用内网啦！
|
|
```
|
|
|
|
|
|
名称 | 含义
|
|
---|---
|
|
config | 配置文件路径
|
|
### 配置文件config.json
|
|
|
|
```
|
|
{
|
|
"Server": {
|
|
"ip": "123.206.77.88",
|
|
"tcp": 8284,
|
|
"vkey": "DKibZF5TXvic1g3kY",
|
|
"num": 10
|
|
}
|
|
}
|
|
```
|
|
名称 | 含义
|
|
---|---
|
|
ip | 服务端ip地址
|
|
tcp | 服务端与客户端通信端口
|
|
vkey | 验证密钥
|
|
num | 服务端与客户端通信连接数
|
|
|
|
|
|
## 操作系统支持
|
|
支持Windows、Linux、MacOSX等，无第三方依赖库。
|