mirror of https://github.com/ThearchyHelios/AgentLab.git synced 2026-11-15 00:21:58 +00:00

Files

T

ThearchyHelios 2714890d0d 文档重新梳理：README 精简成介绍和索引，细节按主题拆进 docs/zh-CN 与 docs/en（17 篇一一对应），英文文档不含中文

README.zh-CN.md / README.md 只留：这是什么、为什么用它、主要功能（按领域一行一条，链到文档）、快速开始、部署、文档索引、
开发与测试、许可（原文不动）。原来的每一节按读者和任务分到 17 篇主题文档：ask-data、workflows、evidence、
data-sources（新增：接入数据库、只读保证、上传表格、跨库合并、遮罩列）、data-catalog、tools（新增：工具、审批档位、
能力登记、端点、网络规则——它们管所有工作流，不只应用）、apps、evaluation-and-ledger、schedules（含通知）、deployment、
configuration、postgresql-and-scaling、identity-and-security、architecture、development、upgrade-notes（按时间倒序，
每波先写要做的事）、faq。删掉的只有模块名（api/copilot_gen.py、chat/drive.py、data/schema_view.py）、重复的话和
「以前…现在…」的叙述；操作步骤、命令、配置名、限制、权限边界都有归宿。中文是原文，英文按新的中文写；英文里界面文字
只写英文名，开头注明界面目前只有简体中文，中文占位符换成英文占位符，中文数字的例子改成不依赖中文的说法。
数据剖析可以同时剖析 2–3 张表（baf23998）收进 data-catalog。
新增 scripts/check-docs.py：英文文档（README.md、docs/en/**）不许有中日韩字符和全角符号（代码块也算），
README、docs/**、deploy/README.md 的相对链接和锚点都要通，docs/zh-CN 与 docs/en 文件一一对应、标题层级相同。
中文提示里指向 README 章节的地方改指新文档：cluster/guard.py、cluster/version.py、db/base.py 两处报错，
data/schema_view.py 文档串，.env.example 三处，scripts/prod.sh、scripts/test-postgres.sh，terms.ts 两处、
DataSourcesTab.tsx、check-manage.mjs 注释，deploy/README.md 三处链接。deploy/agentlab.env 未动。
验收：check-docs 0 问题（英文文档 18 个 0 处中文，相对链接 369 条 0 断链，18 对标题层级一致）；相关后端测试
117 通过、7 跳过；tsc -b、check-copy 通过。

2026-10-21 10:23:26 +08:00

5.6 KiB

Raw Blame History

English | 简体中文

部署

这篇讲怎么把 AgentLab 部署给多人使用：不用 Docker 的 prod.sh、Docker 离线包、数据目录、备份和升级。给运维看。开发时怎么启动见开发。

选哪种方式

不用 Docker：./scripts/prod.sh 在本机构建前端，由后端一并托管页面。
Docker 离线包：在能联网的机器上打包，拷到只装了 Docker Engine 的离线机器上部署。

两种方式默认都不开登录：同一网络里打得开页面的人都能用全部功能。多人使用前先开登录，见身份、权限与安全。放在反向代理后面时，设对外访问地址（见配置）。

不用 Docker：prod.sh

./scripts/prod.sh               # 构建前端（需要时）并启动，地址 http://127.0.0.1:8000
./scripts/prod.sh --workers 4   # 多进程，要先把应用库换成 PostgreSQL

缺省一个进程，不热重载。
前端产物不存在或比源码旧时才重新构建；--build / --no-build 强制构建或跳过。
--port（或 AGENTLAB_PORT）改端口；--host 监听所有网卡。
数据目录默认是仓库下的 data/，用 AGENTLAB_DATA_DIR 改。
应用库默认是数据目录里的 SQLite，只支持单进程：同一个数据目录已经有一个服务在用时，第二个进程拒绝启动，照实报错。不要给 uvicorn 加 --workers；--workers 大于 1 时，prod.sh 先拦下。
换成 PostgreSQL 之后才能多进程，见 PostgreSQL 与多进程。

Docker 离线包

在打包的机器上运行 ./scripts/package-docker.sh。它构建 Linux 镜像（默认取本机架构；目标机不同时加 --platform linux/arm64 或 linux/amd64），连同一键部署脚本、配置模板和部署说明，打成 release/agentlab-<版本>-linux-<arch>.tar。
拷到只装了 Docker Engine 的离线机器上，解包，按需修改 agentlab.env，运行 ./deploy.sh。不需要 docker compose。

安装、升级、备份、沙箱权限和常见问题，见包里的部署说明（仓库里是 deploy/README.md）。

deploy.sh 靠数据目录里的 .agentlab-data 标记文件（或 agentlab.db、.secret_key）认数据目录，别删。
表结构和默认数据在启动时自动补齐。

应用库放哪里

应用库有三种放法，选一种：

放法	怎么做
SQLite（缺省）	什么都不用做
内置 PostgreSQL	新部署用 `./deploy.sh install --postgres`：旁边再起一个 PostgreSQL 容器，端口不对外，密码自动生成在数据目录里。已经在用 SQLite 的，用 `./deploy.sh migrate-to-postgres`：停服务、备份、导入、核对，哪一步出错都退回 SQLite
外接 PostgreSQL	在 `agentlab.env` 里设 `AGENTLAB_DATABASE_URL`

内置和外接只能选一种。
./deploy.sh upgrade 升级前自动备份：SQLite 拷到数据目录的 backups/sqlite/，内置 PostgreSQL 用 pg_dump 存到 backups/postgres/；各留最近 5 份（BACKUP_KEEP），只有属主能读。
restart 缺省只重启服务；restart --postgres 连库一起重启。
多进程：在 agentlab.env 里加一行 AGENTLAB_WORKERS=4。

三种放法的细节见 deploy/README.md 的「用 PostgreSQL」。

离线包里的代码沙箱

镜像里默认带 microVM 的运行时和沙箱镜像（约 150 MB）；打包时加 --no-microvm 可以不带。
目标机有 KVM 时，deploy.sh 先用临时容器试启动一台 microVM。起得来，就把 /dev/kvm 交给容器，代码在 microVM 里执行。部署时不用联网。
没有 KVM 时（Mac、Windows 上的 Docker Desktop，多数云主机），默认权限下代码沙箱退回本地子进程，隔离边界只有容器本身。

数据目录

全部数据都在数据目录（默认 data/）里：

路径	内容
`agentlab.db`	业务数据（应用库）
`checkpoints.db`	执行断点
`artifacts/`	工件库
`workspace/`	沙箱文件
`uploads/`	上传文件
`records/`	填报登记的记录表
`files/`	表单附件
`.secret_key`	加密密钥

删除 data/ 就恢复出厂设置。
应用库用 PostgreSQL 时，不再用 agentlab.db、checkpoints.db，业务数据和断点都在 PostgreSQL 里；其余照旧在 data/，数据目录照样要有、要备份。
几台机器共享一份数据目录时的要求，见多台机器。

备份

用 SQLite 时，数据目录就是全部数据，整份备份它。Docker 部署的做法见 deploy/README.md 的「数据和备份」。
用 PostgreSQL 时，备份是 pg_dump 加数据目录，见备份。
填报的记录表 records/*.db 是原地追加写的 SQLite 文件，开着服务直接拷，可能拷到写了一半的。要么停服务拷，要么用 SQLite 的备份接口逐个拷。

升级

每次升级前，先看升级说明：里面列出对使用者和运维有影响的变化，以及要做的事。
Docker 部署用 ./deploy.sh upgrade：先停掉旧容器（里面的全部工作进程一起停）、备份，再起新版本。
新旧版本的进程不能同时连着一个库，代码里拦着，见升级多进程部署。
流程实例升级后能不能继续，见应用。

5.6 KiB Raw Blame History Unescape Escape

部署