docs(docs): update docs

This commit is contained in:
lxien
2026-10-15 20:36:04 +08:00
parent b49d2bc69a
commit d75fcf5a4c
6 changed files with 28 additions and 12 deletions
+9 -1
View File
@@ -31,10 +31,18 @@
</a>
</div>
<p align="center">
<a href="https://www.star-history.com/orbien-org/orbien">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank" />
<img alt="Star History Rank" src="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank" />
</picture>
</a>
</p>
<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>
+9 -1
View File
@@ -30,7 +30,15 @@
<img src="https://img.shields.io/badge/Discord-Join-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"/>
</a>
</div>
<p align="center">
<a href="https://www.star-history.com/orbien-org/orbien">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank" />
<img alt="Star History Rank" src="https://api.star-history.com/badge?repo=orbien-org/orbien&type=rank" />
</picture>
</a>
</p>
<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>
+2 -2
View File
@@ -6,12 +6,12 @@ title: 带宽限制
# 带宽限制
按隧道限制转发带宽。配置在 `[[tunnels]]` 的 `transport` 下。
按隧道限制转发带宽,配置在 `[[tunnels]]` 的 `transport` 下。
- `bandwidthLimitSide = "client"`:在客户端限速(默认)
- `bandwidthLimitSide = "server"`:在服务端限速
`bandwidth` 为数字,单位固定为Mbps(如 `2`、`0.5`)。`0` 表示不限制。
`bandwidth` 为数字,单位固定为Mbps(如 `2`、`0.5`);`0` 表示不限制。
## 示例:客户端限速
+3 -3
View File
@@ -10,7 +10,7 @@ title: 域名
`domains` 对 http/https 必填且非空。规则:
- 不含 `.` 的短名字(如 `blog`)当作子域前缀,展开为 `{前缀}.{rootDomain}`(需配置服务端 `rootDomain`)
- 不含 `.` 的短名字(如 `web`)当作子域前缀,展开为 `{前缀}.{rootDomain}`(需配置服务端 `rootDomain`)
- 带 `.` 的完整域名(如 `web.example.com`):若属于 `rootDomain` 或其子域,按原样使用;否则当作外部自定义域名,同样按原样使用
- 不支持通配符
@@ -57,10 +57,10 @@ rootDomain = "example.com"
name = "web"
protocol = "http"
service = "127.0.0.1:8080"
domains = ["blog"]
domains = ["web"]
```
访问域名为 `blog.example.com`。也可同时写前缀和完整域名,例如 `domains = ["web", "app.example.com"]`。
访问域名为 `web.example.com`。也可同时写前缀和完整域名,例如 `domains = ["web", "app.example.com"]`。
## 参数
@@ -10,7 +10,7 @@ Forward visitor traffic to a client tunnel by domain. After the server enables `
`domains` is required and must be non-empty for http/https. Rules:
- A short name with no `.` (e.g. `blog`) is treated as a subdomain prefix and expanded to `{prefix}.{rootDomain}` (requires server `rootDomain`)
- A short name with no `.` (e.g. `web`) is treated as a subdomain prefix and expanded to `{prefix}.{rootDomain}` (requires server `rootDomain`)
- A full domain with `.` (e.g. `web.example.com`): if it belongs to `rootDomain` or a subdomain of it, it is used as-is; otherwise it is treated as an external custom domain and also used as-is
- Wildcards are not supported
@@ -57,10 +57,10 @@ Client:
name = "web"
protocol = "http"
service = "127.0.0.1:8080"
domains = ["blog"]
domains = ["web"]
```
The access domain is `blog.example.com`. You can also mix prefixes and full domains, e.g. `domains = ["web", "app.example.com"]`.
The access domain is `web.example.com`. You can also mix prefixes and full domains, e.g. `domains = ["web", "app.example.com"]`.
## Parameters
@@ -17,7 +17,7 @@ const FeatureList: FeatureItem[] = [
),
description: (
<Translate id="homepage.feature.perf.desc">
高性能、低延迟、抗丢包、内存占用低、无GC停顿,适合长期服务器运行
高性能、低延迟、抗丢包、内存占用低、无GC停顿,适合服务器长期运行
</Translate>
),
},
@@ -49,7 +49,7 @@ const FeatureList: FeatureItem[] = [
),
description: (
<Translate id="homepage.feature.security.desc">
支持 Token 鉴权与 TLS /mTLS 加密传输;HTTPS采用透明转发和可选客户端TLS终止
支持 Token 鉴权与 TLS /mTLS 加密传输;HTTPS 采用透明转发和可选客户端 TLS 终止
</Translate>
),
},