Files

119 lines
4.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<div align="center">
<img src="docs/static/img/logo.png" alt="Logo" width="180" height="180" style="border-radius:24px;margin-bottom:20px;"/>
</div>
<p align="center" style="font-size:18px;color:#555;margin-top:-10px;margin-bottom:24px;">
基于 Rust 和 Tokio 实现的内网穿透
</p>
<div align="center">
<a href="https://github.com/orbien-org/orbien/stargazers">
<img src="https://img.shields.io/github/stars/orbien-org/orbien?style=for-the-badge&logo=github" alt="GitHub Stars"/>
</a>
<a href="https://github.com/orbien-org/orbien/forks">
<img src="https://img.shields.io/github/forks/orbien-org/orbien?style=for-the-badge&logo=github" alt="GitHub Forks"/>
</a>
<a href="https://github.com/orbien-org/orbien/issues">
<img src="https://img.shields.io/github/issues/orbien-org/orbien?style=for-the-badge&logo=github" alt="GitHub Issues"/>
</a>
<a href="https://github.com/orbien-org/orbien/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/orbien-org/orbien?style=for-the-badge" alt="License"/>
</a>
<a href="https://www.rust-lang.org/">
<img src="https://img.shields.io/badge/Rust-Tokio-orange?style=for-the-badge&logo=rust&logoColor=white" alt="Rust"/>
</a>
<a href="https://github.com/orbien-org/orbien/releases">
<img src="https://img.shields.io/badge/orbien-3.6.1--beta.1-blue?style=for-the-badge" alt="orbien:3.6.1-beta.1"/>
</a>
<a href="https://somsubhra.github.io/github-release-stats/?username=orbien-org&repository=orbien">
<img src="https://img.shields.io/github/downloads/orbien-org/orbien/total?style=for-the-badge" alt="Downloads"/>
</a>
<a href="https://discord.gg/4dgQjCS3k">
<img src="https://img.shields.io/badge/Discord-Join-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"/>
</a>
</div>
<div align="center">
<a href="https://trendshift.io/repositories/128255?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-128255" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/128255/daily?language=Rust" alt="orbien-org%2Forbien | Trendshift" width="250" height="55"/></a>
</div>
<div align="center">
<a href="README.md"><strong>English</strong></a> &nbsp;|&nbsp;
<a href="README_ZH.md"><strong>简体中文</strong></a>
&nbsp;|&nbsp;
<a href="https://orbien-org.github.io/orbien/"><strong>文档</strong></a>
</div>
![dashboard_zh.png](doc/img/dashboard_zh.png)
一个轻量、高性能、安全的内网穿透工具,二进制体积 `5MB`左右
## 功能特性
- **高性能**:高性能,抗丢包、高吞吐、无GC停顿、内存占用低
- **隧道协议**:支持 TCP、UDP、HTTP、HTTPS、SOCKS5 等多种协议隧道
- **传输协议**:支持 TCP、KCP、WebSocket、QUIC,支持TCP多路复用
- **安全加密**:支持 Token 隧道鉴权以及Tls和mTLS加密传输;HTTPS采用透明转发和客户端TLS终止
- **多平台支持**:支持 Windows、Linux、macOS、freeBSD 等多平台
- **运维管理**:提供轻量Web管理界面和跨平台原生桌面客户端,便于配置和监控
## 快速开始
[下载](https://github.com/orbien-org/orbien/tags)对应平台的二进制压缩包解压
### 服务端
```toml
# orbien-server.toml
listen = "0.0.0.0:9527"
```
```shell
./orbien-server -c orbien-server.toml
```
### 客户端
```toml
# orbien.toml
server = "127.0.0.1:9527"
[[tunnels]]
name = "ssh"
protocol = "tcp"
service = "127.0.0.1:22"
remotePort = 9000
```
```shell
./orbien -c orbien.toml
```
如果觉得命令行 CLI 操作麻烦,可以使用 [Orbien-Desktop](https://github.com/orbien-org/orbien/releases) 桌面客户端。
![desktop_zh.gif](doc/img/desktop_zh.gif)
## 性能测试
| 环境 | 说明 |
|----|--------------------------------------------------------|
| 平台 | macOS 26.2· Darwin 25.2.0 · arm64 |
| 硬件 | Apple M28 核)· 16 GB |
| 详细 | [benchmarks](https://github.com/orbien-org/benchmarks) |
为了排除各种干扰因素,本测试是在本地回环下进行,相较于`frp``Orbien`比较明显的优势是在高并发条件下内存占用更低、更加平稳。
![mem-graph.png](doc/img/bench/mem-graph.png)
![tcp-bitrate.png](doc/img/bench/tcp-bitrate.png)
![udp-bitrate.png](doc/img/bench/udp-bitrate.png)
![http-throughput.png](doc/img/bench/http-throughput.png)
## 许可证
- [Apache License 2.0](https://github.com/orbien-org/orbien/blob/main/LICENSE)
## 联系
- 问题反馈:[issues](https://github.com/orbien-org/orbien/issues)
- 交流群:[discord](https://discord.com/invite/4dgQjCS3k)