Update README.md

This commit is contained in:
he liu 2018-12-01 13:52:48 +08:00 committed by GitHub
parent ed694d1d1d
commit b61ff97681
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 73 additions and 8 deletions

View File

@ -1,16 +1,18 @@
# easyProxy
轻量级、高性能http代理服务器主要应用于内网穿透。支持三种模式,**http代理请求**、**tcp隧道模式**、**sock5代理模式**,可根据自身需求进行选择。
轻量级、高性能http代理服务器主要应用于**内网穿透**。支持四种模式,**http代理请求**、**tcp隧道模式**、**sock5代理模式**、**http代理模式**,可根据自身需求进行选择。
支持客户端与服务端连接中断自动重连多路传输大大的提高请求处理速度go语言编写无第三方依赖经过测试内存占用小普通场景下仅占用10m内存。
水平很有限,不足指出请大家指出
## 背景
1. 我有一个小程序的需求但是小程序的数据源必须从内网才能抓取到但是又苦于内网服务器没有公网ip所以只能内网穿透了。----> [http代理请求](#http代理请求)
1. 我有一个小程序的需求但是小程序的数据源必须从内网才能抓取到但是又苦于内网服务器没有公网ip所以只能内网穿透了。----> [http反向代理请求](#http代理请求)
2. 想在外网通过ssh连接内网的机器或者做云服务器到内网服务器端口的映射---->[tcp隧道模式](#tcp隧道模式)
2. 想在外网通过ssh连接内网的机器或者做云服务器到内网服务器端口的映射---->[tcp隧道模式](#tcp隧道模式)
3. 在外网如同使用内网vpn一样访问内网资源或者设备----> [sock5代理模式](#sock5代理模式)
4. 在外网使用HTTP代理访问内网站点等---->[http代理模式](#http代理模式)
## 特点
- [x] 支持gzip压缩,减小流量消耗
- [x] 支持多站点配置,兼容多个内网网站
@ -18,15 +20,17 @@
- [x] 支持多路传输,提高并发
- [x] 跨站自动匹配替换
- [x] 支持tcp隧道,提升访问效率
- [x] 支持http代理
- [x] 支持内网穿透sock5代理达到在非内网环境下访问内网的效果
- [x] 专注内网穿透
## 目录
1. [安装](#安装)
2. [http代理请求](#http代理请求)
2. [http反向代理请求](#http代理请求)
3. [tcp隧道模式](#tcp隧道模式)
4. [sock5代理模式](#sock5代理模式)
5. [http代理模式](#http代理模式)
5. [操作系统支持](#操作系统支持)
@ -48,7 +52,7 @@
### 场景及原理
较为适用于http也就是web站点的穿透服务端与客户端之间建立连接服务端收到http请求后将请求发送到客户端客户端再执行这个请求并将结果返回给服务端服务端收到后再返回给用户。
![image](https://github.com/cnlh/easyProxy/blob/master/image/http.png?raw=true)
### 使用
- 服务端
@ -157,7 +161,7 @@ server {
### 场景及原理
较为适用于处理tcp连接例如ssh同时也适用于http等访问服务端的8024端口相当于访问内网目标ip的目标端口构成如下所示的隧道。
服务端<----->客户端<----->目标地址
![image](https://github.com/cnlh/easyProxy/blob/master/image/tcp.png?raw=true)
### 使用
@ -216,7 +220,7 @@ num | 服务端与客户端通信连接数
### 场景及原理
主要用于sock5代理也就是和ss类似不过是代理内网。使用此模式时可在非内网环境下配置本机的sock5代理服务器ip、sock5代理端口即可实现sock5代理达到访问内网的网站的效果。
![image](https://github.com/cnlh/easyProxy/blob/master/image/sock5.png?raw=true)
### 使用
- 服务端
@ -247,7 +251,7 @@ httpport | 代理的http端口与nginx配合使用
```
配置sock5即可ip为外网服务器ip端口为httpport即可在外网环境使用内网啦
配置sock5代理即可ip为外网服务器ip端口为httpport即可在外网环境使用内网啦也可使用proxifer等全局代理软件。
```
@ -274,5 +278,66 @@ vkey | 验证密钥
num | 服务端与客户端通信连接数
## http代理模式
### 场景及原理
主要用于HTTP代理区别也就是HTTP代理和sock5代理的区别。使用此模式时可在非内网环境下配置本机的HTTP代理服务器ip、HTTP代理端口即可实现HTTP代理达到访问内网的网站的效果。
![image](https://github.com/cnlh/easyProxy/blob/master/image/httpProxy.png?raw=true)
### 使用
- 服务端
```
./easyProxy -mode httpProxyServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
httpport | 代理的http端口与nginx配合使用
- 客户端
```
建立配置文件 config.json
```
```
./easyProxy -config config.json
```
- 需要使用内网代理的机器
```
配置HTTP代理即可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等无第三方依赖库。