Skip to content

Commit

Permalink
doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
fatedier committed May 7, 2018
1 parent 04560c1 commit 55800dc
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 272 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ frp is a fast reverse proxy to help you expose a local server behind a NAT or fi
* [Hot-Reload frpc configuration](#hot-reload-frpc-configuration)
* [Get proxy status from client](#get-proxy-status-from-client)
* [Port White List](#port-white-list)
* [Port Reuse](#port-reuse)
* [TCP Stream Multiplexing](#tcp-stream-multiplexing)
* [Support KCP Protocol](#support-kcp-protocol)
* [Connection Pool](#connection-pool)
Expand Down Expand Up @@ -413,6 +414,12 @@ allow_ports = 2000-3000,3001,3003,4000-50000

`allow_ports` consists of a specific port or a range of ports divided by `,`.

### Port Reuse

Now `vhost_http_port` and `vhost_https_port` in frps can be same with `bind_port`. frps will detect connection's protocol and handle it accordingly.

We would like to try to allow multiple proxies bind a same remote port with different protocols in the future.

### TCP Stream Multiplexing

frp support tcp stream multiplexing since v0.10.0 like HTTP2 Multiplexing. All user requests to same frpc can use only one tcp connection.
Expand Down
9 changes: 9 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ frp 是一个可用于内网穿透的高性能的反向代理应用,支持 tcp
* [客户端热加载配置文件](#客户端热加载配置文件)
* [客户端查看代理状态](#客户端查看代理状态)
* [端口白名单](#端口白名单)
* [端口复用](#端口复用)
* [TCP 多路复用](#tcp-多路复用)
* [底层通信可选 kcp 协议](#底层通信可选-kcp-协议)
* [连接池](#连接池)
Expand Down Expand Up @@ -438,6 +439,14 @@ allow_ports = 2000-3000,3001,3003,4000-50000

`allow_ports` 可以配置允许使用的某个指定端口或者是一个范围内的所有端口,以 `,` 分隔,指定的范围以 `-` 分隔。

### 端口复用

目前 frps 中的 `vhost_http_port``vhost_https_port` 支持配置成和 `bind_port` 为同一个端口,frps 会对连接的协议进行分析,之后进行不同的处理。

例如在某些限制较严格的网络环境中,可以将 `bind_port``vhost_https_port` 都设置为 443。

后续会尝试允许多个 proxy 绑定同一个远端端口的不同协议。

### TCP 多路复用

从 v0.10.0 版本开始,客户端和服务器端之间的连接支持多路复用,不再需要为每一个用户请求创建一个连接,使连接建立的延迟降低,并且避免了大量文件描述符的占用,使 frp 可以承载更高的并发数。
Expand Down
135 changes: 0 additions & 135 deletions doc/quick_start_en.md

This file was deleted.

137 changes: 0 additions & 137 deletions doc/quick_start_zh.md

This file was deleted.

0 comments on commit 55800dc

Please sign in to comment.