From a6748f30d9f390a16f09e63b8e44c25b262cb1a1 Mon Sep 17 00:00:00 2001 From: Jacob Kiers Date: Wed, 23 Aug 2023 20:45:42 +0200 Subject: [PATCH] Make English readme the default Since I'm unable to read Chinese Signed-off-by: Jacob Kiers --- README-EN.md | 70 --------------------------------------------- README-ZH.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 54 +++++++++++++++-------------------- 3 files changed, 102 insertions(+), 102 deletions(-) delete mode 100644 README-EN.md create mode 100644 README-ZH.md diff --git a/README-EN.md b/README-EN.md deleted file mode 100644 index 338de75..0000000 --- a/README-EN.md +++ /dev/null @@ -1,70 +0,0 @@ -# Fourth - -> Hey, now we are on level 4! - -[![](https://img.shields.io/crates/v/fourth)](https://crates.io/crates/fourth) [![CI](https://img.shields.io/github/workflow/status/kernelerr/fourth/Rust)](https://github.com/KernelErr/fourth/actions/workflows/rust.yml) - -**Under heavy development, version 0.1 may update frequently** - -Fourth is a layer 4 proxy implemented by Rust to listen on specific ports and transfer TCP/KCP data to remote addresses(only TCP) according to configuration. - -## Features - -- Listen on specific port and proxy to local or remote port -- SNI-based rule without terminating TLS connection -- Allow KCP inbound(warning: untested) - -## Installation - -To gain best performance on your computer's architecture, please consider build the source code. First, you may need [Rust tool chain](https://rustup.rs/). - -```bash -$ cd fourth -$ cargo build --release -``` - -Binary file will be generated at `target/release/fourth`, or you can use `cargo install --path .` to install. - -Or you can use Cargo to install Fourth: - -```bash -$ cargo install fourth -``` - -Or you can download binary file form the Release page. - -## Configuration - -Fourth will read yaml format configuration file from `/etc/fourth/config.yaml`, and you can set custom path to environment variable `FOURTH_CONFIG`, here is an minimal viable example: - -```yaml -version: 1 -log: info - -servers: - proxy_server: - listen: - - "127.0.0.1:8081" - default: remote - -upstream: - remote: "tcp://www.remote.example.com:8082" # proxy to remote address -``` - -Built-in two upstreams: ban(terminate connection immediately), echo. For detailed configuration, check [this example](./example-config.yaml). - -## Performance Benchmark - -Tested on 4C2G server: - -Use fourth to proxy to Nginx(QPS of direct connection: ~120000): ~70000 req/s (Command: `wrk -t200 -c1000 -d120s --latency http://proxy-server:8081`) - -Use fourth to proxy to local iperf3: 8Gbps - -## Thanks - -- [tokio_kcp](https://github.com/Matrix-Zhang/tokio_kcp) - -## License - -Fourth is available under terms of Apache-2.0. \ No newline at end of file diff --git a/README-ZH.md b/README-ZH.md new file mode 100644 index 0000000..c2434f2 --- /dev/null +++ b/README-ZH.md @@ -0,0 +1,80 @@ +# Fourth + +> 这一波在第四层。 + +[![](https://img.shields.io/crates/v/fourth)](https://crates.io/crates/fourth) [![CI](https://img.shields.io/github/workflow/status/kernelerr/fourth/Rust)](https://github.com/KernelErr/fourth/actions/workflows/rust.yml) + +[English](/README-EN.md) + +**积极开发中，0.1版本迭代可能较快** + +Fourth是一个Rust实现的Layer 4代理，用于监听指定端口TCP/KCP流量，并根据规则转发到指定目标（目前只支持TCP）。 + +## 功能 + +- 监听指定端口代理到本地或远端指定端口 +- 监听指定端口，通过TLS ClientHello消息中的SNI进行分流 +- 支持KCP入站（警告：未测试） + +## 安装方法 + +为了确保获得您架构下的最佳性能，请考虑自行编译，首选需要确保您拥有[Rust工具链](https://rustup.rs/)。 + +```bash +$ cd fourth +$ cargo build --release +``` + +将在`target/release/fourth`生成二进制文件，您也可以使用`cargo install --path . `来安装二进制文件。 + +或者您也可以使用Cargo直接安装： + +```bash +$ cargo install fourth +``` + +或者您也可以直接从Release中下载二进制文件。 + +## 配置 + +Fourth使用yaml格式的配置文件，默认情况下会读取`/etc/fourth/config.yaml`，您也可以设置自定义路径到环境变量`FOURTH_CONFIG`，如下是一个最小有效配置： + +```yaml +version: 1 +log: info + +servers: + proxy_server: + listen: + - "127.0.0.1:8081" + default: remote + +upstream: + remote: "tcp://www.remote.example.com:8082" # proxy to remote address +``` + +内置两个的upstream：ban（立即中断连接）、echo（返回读到的数据）。更详细的配置可以参考[示例配置](./example-config.yaml)。 + +注意：[::]会默认同时绑定IPv4和IPv6。 + +## 性能测试 + +在4C2G的服务器上测试： + +使用Fourth代理到Nginx（直连QPS 120000）: ~70000req/s （测试命令：`wrk -t200 -c1000 -d120s --latency http://proxy-server:8081 `） + +使用Fourth代理到本地iperf3：8Gbps + +## io_uring? + +尽管经过了很多尝试，我们发现目前一些Rust下面的io_uring实现存在问题，我们使用的io_uring库实现尽管在吞吐量上可以做到单线程20Gbps（相比之下Tokio仅有8Gbps），但在QPS上存在性能损失较大的问题。因此在有成熟的io_uring实现之前，我们仍然选择epoll。之后我们会持续关注相关进展。 + +可能以后会为Linux高内核版本的用户提供可选的io_uring加速。 + +## 感谢 + +- [tokio_kcp](https://github.com/Matrix-Zhang/tokio_kcp) + +## 协议 + +Fourth以Apache-2.0协议开源。 diff --git a/README.md b/README.md index c2434f2..338de75 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,41 @@ # Fourth -> 这一波在第四层。 +> Hey, now we are on level 4! [![](https://img.shields.io/crates/v/fourth)](https://crates.io/crates/fourth) [![CI](https://img.shields.io/github/workflow/status/kernelerr/fourth/Rust)](https://github.com/KernelErr/fourth/actions/workflows/rust.yml) -[English](/README-EN.md) +**Under heavy development, version 0.1 may update frequently** -**积极开发中，0.1版本迭代可能较快** +Fourth is a layer 4 proxy implemented by Rust to listen on specific ports and transfer TCP/KCP data to remote addresses(only TCP) according to configuration. -Fourth是一个Rust实现的Layer 4代理，用于监听指定端口TCP/KCP流量，并根据规则转发到指定目标（目前只支持TCP）。 +## Features -## 功能 +- Listen on specific port and proxy to local or remote port +- SNI-based rule without terminating TLS connection +- Allow KCP inbound(warning: untested) -- 监听指定端口代理到本地或远端指定端口 -- 监听指定端口，通过TLS ClientHello消息中的SNI进行分流 -- 支持KCP入站（警告：未测试） +## Installation -## 安装方法 - -为了确保获得您架构下的最佳性能，请考虑自行编译，首选需要确保您拥有[Rust工具链](https://rustup.rs/)。 +To gain best performance on your computer's architecture, please consider build the source code. First, you may need [Rust tool chain](https://rustup.rs/). ```bash $ cd fourth $ cargo build --release ``` -将在`target/release/fourth`生成二进制文件，您也可以使用`cargo install --path . `来安装二进制文件。 +Binary file will be generated at `target/release/fourth`, or you can use `cargo install --path .` to install. -或者您也可以使用Cargo直接安装： +Or you can use Cargo to install Fourth: ```bash $ cargo install fourth ``` -或者您也可以直接从Release中下载二进制文件。 +Or you can download binary file form the Release page. -## 配置 +## Configuration -Fourth使用yaml格式的配置文件，默认情况下会读取`/etc/fourth/config.yaml`，您也可以设置自定义路径到环境变量`FOURTH_CONFIG`，如下是一个最小有效配置： +Fourth will read yaml format configuration file from `/etc/fourth/config.yaml`, and you can set custom path to environment variable `FOURTH_CONFIG`, here is an minimal viable example: ```yaml version: 1 @@ -53,28 +51,20 @@ upstream: remote: "tcp://www.remote.example.com:8082" # proxy to remote address ``` -内置两个的upstream：ban（立即中断连接）、echo（返回读到的数据）。更详细的配置可以参考[示例配置](./example-config.yaml)。 +Built-in two upstreams: ban(terminate connection immediately), echo. For detailed configuration, check [this example](./example-config.yaml). -注意：[::]会默认同时绑定IPv4和IPv6。 +## Performance Benchmark -## 性能测试 +Tested on 4C2G server: -在4C2G的服务器上测试： +Use fourth to proxy to Nginx(QPS of direct connection: ~120000): ~70000 req/s (Command: `wrk -t200 -c1000 -d120s --latency http://proxy-server:8081`) -使用Fourth代理到Nginx（直连QPS 120000）: ~70000req/s （测试命令：`wrk -t200 -c1000 -d120s --latency http://proxy-server:8081 `） +Use fourth to proxy to local iperf3: 8Gbps -使用Fourth代理到本地iperf3：8Gbps - -## io_uring? - -尽管经过了很多尝试，我们发现目前一些Rust下面的io_uring实现存在问题，我们使用的io_uring库实现尽管在吞吐量上可以做到单线程20Gbps（相比之下Tokio仅有8Gbps），但在QPS上存在性能损失较大的问题。因此在有成熟的io_uring实现之前，我们仍然选择epoll。之后我们会持续关注相关进展。 - -可能以后会为Linux高内核版本的用户提供可选的io_uring加速。 - -## 感谢 +## Thanks - [tokio_kcp](https://github.com/Matrix-Zhang/tokio_kcp) -## 协议 +## License -Fourth以Apache-2.0协议开源。 +Fourth is available under terms of Apache-2.0. \ No newline at end of file