跳到內容

Remote Hub 部署

Remote Hub 把供應商憑證、模型目錄與用量記錄保存在一台主機上,已驗證的用戶端直接連到資料平面。管理平面彼此分離:選用的管理監聽器只綁定 127.0.0.1,僅提供儀表板與 /api/*。它不提供 /v1/*/healthz/readyz 或 WebSocket。不要直接發布 10101,也不要使用 Tailscale Funnel。

standalone 在同一台機器上執行全部功能;hub 保存供應商金鑰與用量;client 只保存連線狀態與專屬資料金鑰。

Terminal window
ocx connect https://hub-name.tailnet-name.ts.net --pairing-code-stdin
ocx connect status
ocx sync

用戶端金鑰會寫入只有擁有者可讀的 service-api-token,絕不寫入 config.json。連線期間,用量來自 hub 並依穩定的 apiKeyId 篩選;中斷後則顯示本機記錄。兩者不會互相鏡像。

Admin token 只能執行一般管理,永遠不能建立使用者同意工作階段。同意操作必須使用伺服器簽發的 gui-session、相符的 Origin 與 CSRF。Tailscale-User-Login 只在獨立管理入口可信;請在 remoteGui.allowedTailscaleUsers 填入完整且正確的登入名稱。

Terminal window
ocx config set runtimeRole hub
ocx config set hostname 100.64.0.10
ocx config set hub.managementPublicOrigin '"https://hub-name.tailnet-name.ts.net"'
ocx config set corsAllowOrigins '["http://localhost:10100"]'
ocx config set hub.managementIngress '{"enabled":true,"port":10101}'
ocx config set remoteGui.allowedTailscaleUsers '["operator@example.com"]'
export OPENCODEX_API_AUTH_TOKEN="$(openssl rand -hex 32)"
ocx service install

systemd/launchd 從受保護的 service-api-token 讀取金鑰,plist 與 unit 不包含明文金鑰。

Terminal window
curl --fail --silent http://100.64.0.10:10100/healthz
curl --fail --silent http://100.64.0.10:10100/readyz
tailscale serve --bg --https=443 http://127.0.0.1:10101
tailscale serve status

/healthz 只證明程序仍在執行。還必須驗證 /readyz、已驗證的 GET /v1/catalog 與一次真實模型回應。管理連接埠只能監聽 127.0.0.1。自管 TLS proxy 應使用 tailscale cert hub-name.tailnet-name.ts.net,並只代理到 127.0.0.1:10101。不要偽造 Tailscale-User-*;沒有可信身分時請使用一次性配對。

Terminal window
ocx config set oauthOpenBrowser false
ocx connect rotate --pairing-code-stdin
# 僅限 HTTPS:
ocx connect rotate --admin-token-stdin

透過 POST /api/oauth/login 啟動 OAuth。若 callback 無法連到 hub,請把最終 URL 或授權碼以 {provider,input} 傳送到 POST /api/oauth/login/code。不要把 OAuth 碼放入 argv 或記錄。

輪替期間,舊金鑰與新金鑰會在同一個 apiKeyId 下最多同時有效十分鐘。舊金鑰備份到 service-api-token.prev,新金鑰以原子方式安裝,透過 /v1/catalog 驗證後再提交。若提交結果不確定,請使用暫時權限重新執行命令;驗證兩個候選金鑰前不要刪除任何檔案。

ocx disconnect 即使 hub 離線也能還原本機狀態,但不會撤銷 hub 金鑰。中斷後,唯一的撤銷入口是 hub 的 Integrations → API Keysocx connect revoke --admin-token-stdin 只能在仍連線時使用。

opencodex 不發布官方 Docker 映像,但儲存庫提供維護的 Dockerfilecompose.yaml,可在本機建置以 digest 固定的 Bun 映像。第一次啟動前,透過 stdin 初始化一次資料金鑰;金鑰不會被輸出,並以僅擁有者可讀的權限保存在 ocx-state volume。

主機需要安裝 Git 與 Bun。每次建置映像前,都應從 Git 追蹤的原始碼產生標準相容性清單,產生後到建置完成前不要修改原始碼。產生的 JSON 不加入 Git;.git 不進入 Docker 建置上下文。主機連接埠預設繫結至 127.0.0.1。遠端存取須明確使用 OPENCODEX_BIND_ADDRESS=<LAN或Tailscale-IP> docker compose up -d0.0.0.0 會公開所有介面。請使用防火牆與經過身分驗證的 TLS/tailnet 前端保護存取。

建置會拒絕過期清單,並將每個 SHA-256 分別與建置上下文及複製後的檔案核對。缺少或不符的檔案、清單以外的原始碼及符號連結都會導致失敗。必須包含 package.jsonbun.lock,以及 scripts/ 中唯一納入的 scripts/model-metadata.source.json

Terminal window
git clone https://github.com/lidge-jun/opencodex.git
cd opencodex
bun scripts/generate-compatibility-version.ts
docker compose build
openssl rand -hex 32 | docker compose run --rm -T hub bun run docker/bootstrap-token.ts
docker compose up -d

容器以非 root 的 bun 使用者執行,根檔案系統唯讀,且只發布 10100。不要發布 10101,也不要把金鑰放入 ARGENVCOPY、Compose、映像歷史或 argv。healthcheck 後仍須分別驗證 readiness、已驗證目錄與真實請求。docker compose down 會保留 volume;docker compose down --volumes 也會刪除設定、憑證與資料金鑰。

  • hub 無法連線:可以離線中斷,但遠端金鑰仍待撤銷。
  • 目錄過期:僅在暫時故障時保留已驗證的 LKG;驗證、結構、大小或協定錯誤不會切換到本機供應商。
  • .prev 復原:保留兩個檔案,使用暫時權限重新執行輪替。
  • hub-too-new/hub-too-old 會指出需要升級的一端,並在本機寫入前失敗。
  • 配對碼只能使用一次,失敗次數會觸發 429;遺失後請重新建立。
  • 非迴路 HTTP 配對必須明確使用 --allow-insecure-http;Admin token 絕不透過 HTTP 傳送。
  • 瀏覽器 logout/expiry 只影響工作階段,不會撤銷資料金鑰。
  • tailscale serve reset 會刪除節點上的所有映射,請先查看 tailscale serve status