starred/orbien
1
0
Fork 0
mirror of https://github.com/orbien-org/orbien.git synced 2026-09-22 08:01:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Enhance docs

Browse Source
This commit is contained in:
lxien
2026-08-16 11:43:40 +08:00
parent f1f0e7f0c2
commit 7fb7bc2cd5
6 changed files with 14 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -73,9 +73,9 @@ listen = "0.0.0.0:9527"
server = "127.0.0.1:9527"
[[tunnels]]
name = "mysql"
name = "ssh"
protocol = "tcp"
service = "127.0.0.1:3306"
service = "127.0.0.1:22"
remotePort = 9000
```
README_ZH.md
+2 -2
View File
@@ -73,9 +73,9 @@ listen = "0.0.0.0:9527"
server = "127.0.0.1:9527"
[[tunnels]]
name = "mysql"
name = "ssh"
protocol = "tcp"
service = "127.0.0.1:3306"
service = "127.0.0.1:22"
remotePort = 9000
```
docs/docs/features/dashboard.md
-15
View File
@@ -34,18 +34,3 @@ password = "123456"
| `dashboard.user` | 否 | | Basic Auth 用户名 |
| `dashboard.password` | 否 | | Basic Auth 密码 |
| `dashboard.staticDir` | 否 | | 静态资源目录；空则使用内置前端 |
## 命令行
无配置文件时也可用参数开启：
```shell
./orbien-server --dashboard_port 8020 --dashboard_user admin --dashboard_pwd 123456
```
| 参数 | 默认值 | 说明 |
|--------------------|-----------|-------------|
| `--dashboard_addr` | `0.0.0.0` | 监听地址 |
| `--dashboard_port` | `0` | 监听端口；`0` 关闭 |
| `--dashboard_user` | `admin` | 用户名 |
| `--dashboard_pwd` | `admin` | 密码 |
docs/docs/features/public-bind.md
+8 -9
View File
@@ -8,13 +8,12 @@ title: 对外监听地址
服务端有两类监听：
| 用途 | 配置 | 谁连 |
|------|-----------------------------------------------------------|-----------------------|
| 控制通道 | `listen`（以及 `quicPort` / `kcpPort`） | **客户端** orbien 连上来建隧道 |
| 对外流量 | `proxyAddr` + `remotePort` / `httpGwPort` / `httpsGwPort` | **公网访客** 访问你穿透出去的服务 |
| 用途 | 配置 | 谁连 |
|------|-----------------------------------------|-----------------------|
| 控制通道 | `listen`（以及 `quicPort` / `kcpPort`） | **客户端** orbien 连上来建隧道 |
| 对外流量 | `proxyAddr` + `remotePort` / `httpGwPort` / `httpsGwPort` | **公网访客** 访问你穿透出去的服务 |
`proxyAddr` 决定访客流量绑在哪张网卡 / 哪个地址上，与客户端连哪无关。配置键名沿用 `proxyAddr`，语义是**对外监听地址**
，不是产品里的「代理隧道」。
`proxyAddr` 决定访客流量绑在哪张网卡 / 哪个地址上，与客户端连哪无关。配置键名沿用 `proxyAddr`，语义是**对外监听地址**。
典型场景：机器多网卡时，控制通道只听内网，对外监听只挂公网 IP；或反过来隔离管理面与业务面。
@@ -42,6 +41,6 @@ proxyAddr = "203.0.113.10"
## 参数
| 参数 | 必填 | 默认值 | 说明 |
|-------------|----|-----------|-----------------------------|
| `proxyAddr` | 否 | `0.0.0.0` | 对外监听地址；空则回退为 `listen` 的主机部分 |
| 参数 | 必填 | 默认值 | 说明 |
|-------------|----|-----------|--------------------------------|
| `proxyAddr` | 否 | `0.0.0.0` | 对外监听地址；空则回退为 `listen` 的主机部分 |
docs/i18n/en/docusaurus-plugin-content-docs/current/features/dashboard.md
-15
View File
@@ -34,18 +34,3 @@ Open `http://SERVER_IP:8020` in a browser and log in with Basic Auth (`user` / `
| `dashboard.user` | No | | Basic Auth username |
| `dashboard.password` | No | | Basic Auth password |
| `dashboard.staticDir` | No | | Static assets directory; empty uses the built-in frontend |
## Command line
You can also enable it with flags when there is no config file:
```shell
./orbien-server --dashboard_port 8020 --dashboard_user admin --dashboard_pwd 123456
```
| Flag | Default | Description |
|--------------------|-------------|--------------------------------|
| `--dashboard_addr` | `0.0.0.0` | Listen address |
| `--dashboard_port` | `0` | Listen port; `0` disables it |
| `--dashboard_user` | `admin` | Username |
| `--dashboard_pwd` | `admin` | Password |
docs/src/components/DownloadMatrix/index.tsx
+2 -1
View File
@@ -26,7 +26,6 @@ type Row = {
noteId: NoteId;
};
/** Must match what `.github/workflows/release.yml` actually uploads. */
const RELEASE_BUILDS: ReadonlySet<string> = new Set([
'orbien-server|linux|amd64|gnu',
'orbien-server|linux|amd64|musl',
@@ -49,7 +48,9 @@ const RELEASE_BUILDS: ReadonlySet<string> = new Set([
'orbien|freebsd|amd64',
'orbien-desktop|linux|amd64|gnu',
'orbien-desktop|linux|arm64|gnu',
'orbien-desktop|windows|amd64',
'orbien-desktop|windows|arm64',
'orbien-desktop|darwin|amd64',
'orbien-desktop|darwin|arm64',
]);