diff --git a/README.md b/README.md index 94457c6..d1808f8 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Rust - orbien:2.1.0-SNAPSHOT + orbien:3.0.0 Downloads @@ -45,7 +45,7 @@ A lightweight, high-performance, and secure intranet penetration tool with a bin ## Features - **High performance**: end-to-end zero-copy forwarding, low latency, high throughput, no GC pauses, and low memory usage -- **Proxy protocols**: TCP, UDP, HTTP, HTTPS, and more +- **Tunnel protocols**: TCP, UDP, HTTP, HTTPS, and more - **Transport protocols**: TCP, KCP, WebSocket, QUIC, with TCP multiplexing support - **Security**: Token-based tunnel authentication, TLS and mTLS encryption; HTTPS supports transparent forwarding and client-side TLS termination - **Cross-platform**: Windows, Linux, macOS, FreeBSD, and more @@ -59,8 +59,7 @@ A lightweight, high-performance, and secure intranet penetration tool with a bin ```toml # orbien-server.toml -bindAddr = "0.0.0.0" -bindPort = 9527 +listen = "0.0.0.0:9527" ``` ```shell @@ -71,31 +70,25 @@ bindPort = 9527 ```toml # orbien.toml -serverAddr = "127.0.0.1" -serverPort = 9527 +server = "127.0.0.1:9527" -[[proxies]] +[[tunnels]] name = "mysql" -type = "tcp" -localIP = "127.0.0.1" -localPort = 3306 -remotePort = 6050 +protocol = "tcp" +service = "127.0.0.1:3306" +remotePort = 9000 ``` ```shell ./orbien -c orbien.toml ``` -If you prefer not to use the CLI, try the [Orbien-Desktop](https://github.com/orbien-org/orbien/releases) desktop client — built with `Tauri`, under `10MB`. +If you prefer not to use the CLI, try the [Orbien-Desktop](https://github.com/orbien-org/orbien/releases) desktop native GUI client. ![desktop_en.gif](doc/img/desktop_en.gif) # Benchmark -The chart below shows results from local loopback tests. Orbien keeps memory usage very low and stable. +The chart below shows local loopback memory usage. Compared with `frp`, Orbien uses less memory and stays more stable. ![mem.png](doc/img/mem.png) - -# Acknowledgements - -This project draws architectural inspiration from [frp](https://github.com/fatedier/frp). The desktop client's UI layout is inspired by [frpc-desktop](https://github.com/luckjiawei/frpc-desktop). Thanks to the open-source community. diff --git a/README_ZH.md b/README_ZH.md index da27eb4..2f3db39 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -21,7 +21,7 @@ Rust - orbien:2.1.0-SNAPSHOT + orbien:3.0.0 Downloads @@ -44,12 +44,12 @@ ## 功能特性 -- **高性能**：全链路零拷贝转发，低延迟、高吞吐、无GC停顿、内存占用低 -- **代理协议**：支持 TCP、UDP、HTTP、HTTPS等多种协议代理 +- **高性能**：高性能，抗丢包、高吞吐、无GC停顿、内存占用低 +- **隧道协议**：支持 TCP、UDP、HTTP、HTTPS 等多种协议隧道 - **传输协议**：支持 TCP、KCP、WebSocket、QUIC，支持TCP多路复用 - **安全加密**：支持 Token 隧道鉴权以及Tls和mTLS加密传输；HTTPS采用透明转发和客户端TLS终止 - **多平台支持**：支持 Windows、Linux、macOS、freeBSD 等多平台 -- **运维管理**：提供轻量Web管理界面和跨平台桌面客户端，便于配置和监控 +- **运维管理**：提供轻量Web管理界面和跨平台原生桌面客户端，便于配置和监控 ## 快速开始 @@ -59,8 +59,7 @@ ```toml # orbien-server.toml -bindAddr = "0.0.0.0" -bindPort = 9527 +listen = "0.0.0.0:9527" ``` ```shell @@ -71,33 +70,25 @@ bindPort = 9527 ```toml # orbien.toml -serverAddr = "127.0.0.1" -serverPort = 9527 +server = "127.0.0.1:9527" -[[proxies]] +[[tunnels]] name = "mysql" -type = "tcp" -localIP = "127.0.0.1" -localPort = 3306 -remotePort = 6050 +protocol = "tcp" +service = "127.0.0.1:3306" +remotePort = 9000 ``` ```shell ./orbien -c orbien.toml ``` -如果觉得命令行CLI操作麻烦，可以使用 [Orbien-Desktop](https://github.com/orbien-org/orbien/releases) 桌面端，该桌面端基于 -`Tauri`框架开发，体积不到`10MB` +如果觉得命令行 CLI 操作麻烦，可以使用 [Orbien-Desktop](https://github.com/orbien-org/orbien/releases) 桌面客户端。 -![desktop.gif](doc/img/desktop.gif) +![desktop_zh.gif](doc/img/desktop_zh.gif) # 性能测试 -下图是基于本地回环进行的测试结果，可以发现`Orbien`的内存占用非常低且稳定。 +下图是基于本地回环的内存占用测试结果。相较于`frp`，`Orbien`的内存占用更低且更稳定: ![mem.png](doc/img/mem.png) - -# 致谢 - -本项目参考了[frp](https://github.com/fatedier/frp) -的架构思路，桌面客户端UI布局借鉴[frpc-desktop](https://github.com/luckjiawei/frpc-desktop)的交互，感谢开源社区的贡献。 \ No newline at end of file diff --git a/doc/img/desktop_en.gif b/doc/img/desktop_en.gif index dbfe638..24e40cc 100644 Binary files a/doc/img/desktop_en.gif and b/doc/img/desktop_en.gif differ diff --git a/doc/img/desktop_zh.gif b/doc/img/desktop_zh.gif new file mode 100644 index 0000000..43a3b14 Binary files /dev/null and b/doc/img/desktop_zh.gif differ