docs: add Setup Keys / PAT guide with API rename workaround

Document Setup Keys concept vs SSO, PAT creation and usage, and the
workaround for renaming a setup key — the API silently ignores the
name field on PUT, so the fix is to UPDATE store.db directly and
restart netbird-server.
This commit is contained in:
2026-04-18 09:44:48 +08:00
parent d026ce4ba9
commit fc9d72e12d
3 changed files with 142 additions and 1 deletions

View File

@@ -81,6 +81,7 @@ reopen fd 8: permission denied
| apt 的 crun 1.14.1 報 `unknown version specified` | crun 的 OCI spec 1.0.0 與 Docker 29.4 不相容 | 從 GitHub 下載 crun 1.20 |
| 502 Bad Gateway所有 API 端點) | netbird-server 下載 GeoLite2 中,尚未開始監聽 port 80 | 等待 2-5 分鐘 |
| 手機 App`server closed the stream without sending trailers` | 透過 NPM 對外公開時NPM 用 `proxy_pass` 而非 `grpc_pass` 轉 gRPC加上 Caddy `:80` 預設不支援 h2c | NPM 加 `advanced_config`gRPC 路由)+ Caddy 全域啟用 `protocols h1 h2 h2c`;見 [npm-grpc-fix.md](./npm-grpc-fix.md) |
| `PUT /api/setup-keys/{id}` 回 200 但 `name` 沒改 | NetBird API 只更新 `auto_groups``revoked``name` 是 read-only | 改 `store.db``setup_keys.name` → 重啟 `netbird-server`;見 [setup-keys-and-pat.md](./setup-keys-and-pat.md) |
## 檔案位置
@@ -91,7 +92,8 @@ reopen fd 8: permission denied
├── QUICKSTART.md ← 快速部署步驟
├── SUMMARY.md ← 本檔(部署摘要)
├── netbird-selfhosted-setup.md ← 完整安裝指南
── npm-grpc-fix.md ← 經 NPM 對外公開時的 gRPC 修復
── npm-grpc-fix.md ← 經 NPM 對外公開時的 gRPC 修復
└── setup-keys-and-pat.md ← Setup Keys / PAT 操作與 API 限制繞道
```
### 遠端伺服器192.168.42.127:/opt/netbird/