Sentinel API v1

從第一個 API 呼叫到正式環境

Docker deployment

部署 API-only Edge Runtime

預設 Compose 不包含 UI。API、取流、推理、事件保存與 webhook outbox 在單獨的 Runtime 服務中運行。

部署套件

deploy/api/
├── docker-compose.yml
├── .env.example
├── bootstrap.sh
├── quickstart.sh
├── quickstart.ps1
├── recovery/
├── README.md
└── smoke-test.sh

目前套件隨原始碼提供;公開且不可變的 container registry URL 是正式發布 gate,在 registry 與 digest 公布前不要編造 docker pull 指令。

啟動

macOS、Linux 或 Ubuntu/WSL

cd deploy/api
./quickstart.sh

Windows PowerShell

Set-Location .\deploy\api
powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\quickstart.ps1

這個指令會在需要時建立金鑰、啟動無頭節點、等待 readiness、執行第一則 Event 範例,並讓 Runtime 繼續運行;不會啟動 UI。

Windows 11 首次安裝與復原

持久化

資料庫、來源/Monitor 期望狀態、事件、Webhook outbox 與圖片證據使用 /data 持久化 volume;模型快取使用 /models 的獨立 volume。刪除 container 不應刪除這些資料。

綁定位址與 TLS

預設只發布到 127.0.0.1。同機 TLS reverse proxy 應保持 loopback,upstream 指向 127.0.0.1:8000。只有 proxy 在另一台機器時才設定 SENTINEL_ALLOW_LAN=1,並綁定 Edge 的精確 private management IP(不要用 0.0.0.0);防火牆只允許 proxy IP/CIDR。不能使用萬用 CORS,也不能讓 client 直接連 8000。

UI 的位置

可選控制台用於預覽第一路來源、調整與測試 Monitor、查看事件與傳送失敗,以及確認主機資源是否足夠。它是 API client,不是 Runtime supervisor。正式 API-only 模式可以從未安裝 UI。

舊版 Electron 相容模式的 Session 可能仍跟隨 UI 連線生命週期。只有從 deploy/api 啟動的 API Runtime 才適用『關閉 UI 仍持續監控』的保證,直到桌面版完成 /v1 遷移。