mirror of
https://github.com/whyour/qinglong.git
synced 2026-09-20 16:07:11 +08:00
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
# QingLong 3.0 Local Web Console
|
||
|
||
Local Web Console 是 `@qinglong/local-api` 的 opt-in 操作界面，用来查看 Task、Run 和执行事件，并显式启动或取消一次运行。它不是当前 headless Local Alpha Trial Kit 的组成部分，也不是 2.x Web UI 的完整替代品。
|
||
|
||
## 选择部署档位
|
||
|
||
| 场景 | 建议 |
|
||
| --- | --- |
|
||
| 内存很小、只需后台自动化的路由/NAS | 继续使用默认 `edge` headless Application；Console 零增量 |
|
||
| 路由/NAS 需要临时人工查看与操作 | 选择 `edge-application-api`，只通过 loopback 或 SSH tunnel 访问 |
|
||
| 普通单节点服务器 | 选择 `standalone-application-api` |
|
||
| Kubernetes/Cluster 节点 | 不使用本 Local Console；继续使用 Cluster Control/Console 路径 |
|
||
|
||
当前仓库能生成 Node.js `application-api` 制品；D-416 的 v3 Docker Trial Kit 仍只包含 headless Application。需要下载即用的 Console image/quickstart 时，应等待后续 Console Trial Kit 切片，不能把本页命令误认为当前公开下载物。
|
||
|
||
## 前置条件
|
||
|
||
- 已完成 Local fresh setup，并有受支持的 Application config；
|
||
- Owner pepper keyring 与 SQLite active pepper 一致；
|
||
- 已通过 [`ql3-identity`](./ql3-local-identity-credential.md) 为 active Identity 签发 API credential；
|
||
- credential 对目标 Project 至少有读取 Task/Run 的权限；启动和取消分别还需要 `run.start` 与 `run.stop`；
|
||
- config、keyring、database 和 credential delivery 保持既有 `0700/0600`、no-symlink 和同 UID authority。
|
||
|
||
## 启动
|
||
|
||
创建私有 `local-api.json`：
|
||
|
||
```json
|
||
{
|
||
"schema": "qinglong/local-api-process@v1",
|
||
"deploymentRoot": "/srv/qinglong3",
|
||
"applicationConfigFilePath": "/srv/qinglong3/private/application.json",
|
||
"ownerPepperKeyringDirectory": "/srv/qinglong3/private/owner-pepper",
|
||
"listener": { "host": "127.0.0.1", "port": 5701 }
|
||
}
|
||
```
|
||
|
||
运行同一进程的 Application + API + Console：
|
||
|
||
```sh
|
||
ql3-local-api --config /srv/qinglong3/private/local-api.json
|
||
```
|
||
|
||
在设备本机打开 `http://127.0.0.1:5701/`。服务只接受 `127.0.0.1` 或 `::1`，不会监听 LAN 地址。
|
||
|
||
从管理电脑访问路由/NAS 时，显式建立受信 SSH tunnel：
|
||
|
||
```sh
|
||
ssh -L 5701:127.0.0.1:5701 router.example
|
||
```
|
||
|
||
随后在管理电脑打开 `http://127.0.0.1:5701/`。不要用反向代理临时绕过 loopback；TLS、可信代理、CSRF 和远程会话边界尚未作为本阶段产品门验收。
|
||
|
||
## 使用
|
||
|
||
1. 输入 Project ID 和 `ql3c_…` API credential，选择“连接本机”。
|
||
2. 在“任务”中选择 Task，核对 revision/content fence 后才能“运行一次”。
|
||
3. 在“运行”中选择 durable Run，按 Event sequence 判断实际进度。
|
||
4. “请求取消”只提交 durable cancellation intent；界面出现 `cancelled|failed|succeeded|timed_out` 终态前，不要认为进程已经停止。
|
||
5. 完成后选择“断开并清除凭据”，再关闭页面。
|
||
|
||
Credential 只存在当前页面内存，不进入 URL、Cookie 或 Web Storage。页面刷新会丢失 credential，需要重新输入；这是当前安全边界，不是缺陷。
|
||
|
||
## 当前阶段可用边界
|
||
|
||
当前可操作闭环是 Task list/read/start 与 Run list/read/events/steps/cancel。页面不负责：
|
||
|
||
- 创建、编辑、启停 Task；
|
||
- Identity、Policy、Secret、Plugin Package 或 AI 配置管理；
|
||
- Run log 展示、终端、文件管理或 2.x 数据迁移；
|
||
- LAN/public 暴露、TLS termination、多用户 Web session 或 Cluster 管理。
|
||
|
||
三项静态资产总计 43,252 bytes，不依赖 CDN、网络字体或前端框架。`edge-application-api` 制品为 3,953,346 bytes/467 files，`standalone-application-api` 为 3,953,490 bytes/467 files；基础 headless Profile 不携带这些资产。
|
||
|
||
停止 Local API 进程走与 Application 相同的 drain/shutdown 路径。Console 没有独立数据库、后台任务或需要额外清理的持久状态。
|