重构配置相关
This commit is contained in:
@@ -336,7 +336,7 @@ stateDiagram-v2
|
||||
- 兼容:旧版 `models[]`(扁平)自动迁移到 `platforms[]` 层级;旧版 `web_search.*` 迁移到 `mcp_servers[]`(log.info 提示)。
|
||||
- 规范化:`normalizePlatforms` 校验 `name/url/type`,key 层 `concurrency`,model 层 `{id, display_name, vision, enable, extra_params, thinking_params, profile}`;同平台内 model id 必须唯一(内部唯一键 = 平台名/模型id);`profile` 引用不存在的名字直接报错。
|
||||
- `model_profiles`(顶层,`normalizeModelProfiles`):多套可复用的 prompt+tools 组合,每项 `{tools_allow?, system_prompt_file?}`,两者至少配一个。`tools_allow` 按**最终发给模型的工具名**匹配(内置 + MCP,含 `服务名__` 前缀,与 prompt.txt dump 同源可对);未配 = 全量,**空数组 `[]` = 零工具(纯文本组合)**——与 MCP 的 `tools_allow`(空名单视作未配)有意不同。`system_prompt_file` 相对 `server/templates/`(compose 已 bind-mount ./app/server,宿主直接可改),**配置加载时一次性读入常驻内存**,缺失/为空报错拦在保存/重启预检;自定义文件 = 完全接管模板正文,技能清单靠模板内 `{APP_SKILLS}` 占位符就地插入(不放 = 无技能段;默认模板同机制,见 §5.2),语言指令始终尾拼。运行期切换(前端传参)零 IO、不碰本配置。
|
||||
- 默认值(`DEFAULTS`):port=8090、log_level=info、terminal default 30s/10K、agent temperature=1.0、max_tool_iterations=20、max_retries=2、model_hold 3min/30min/10s、上传 1.5MB 阈值/2000px/0.85。
|
||||
- 默认值(`DEFAULTS`):port=8090、workspace_root/data_root=`/workspace/tasks` `/workspace/data`、log_level=info、terminal 30s/10K、agent temperature=1.0、max_tool_iterations=50、max_retries=2、model_hold 3min/30min/10s、上传 1.5MB/2000px/0.85;内置 `model_profiles` 含 `mini`(文件/终端/网页白名单 + `mini-system.txt`)与 `zero`(零工具 + `zero-system.txt`)。`config.yml` 只覆盖 deploy 相关段,其余走默认值;整份清单见 `app/config.example.yml`。
|
||||
- 读写:`readConfigText` / `writeConfigText`(先校验后写,无原子 rename,因 bind mount 上 rename 会 EBUSY);`applyEditsToText` 用 `YAML.Document` 保留注释。
|
||||
- `getConfig` 是浅引用,路由层拿到的就是运行中实例,**改完 in-memory 不影响**(要重启)。
|
||||
|
||||
@@ -469,10 +469,10 @@ AI 通过 `schedule_task` 工具为所在会话建周期性任务(`scheduled_t
|
||||
|
||||
## 9. 配置
|
||||
|
||||
详见 `app/config.example.yml`(被 `cp` 为顶层 `config.yml` 部署,**已 gitignore**)。要点:
|
||||
详见 `app/config.example.yml`(字段与 `server/config.js` 的 `DEFAULTS` 一一对应;顶层 `config.yml` 由 `scripts/init.sh` 生成或手建,**已 gitignore**)。要点:
|
||||
|
||||
- `platforms[].keys[].models[]` —— 三层层级。内部唯一键 = `平台名/模型id`(用于历史会话回绑、用量统计),**改名等于重建其下所有模型**。
|
||||
- `model_profiles`(顶层)—— 多套可复用的 prompt+tools 组合(`{tools_allow?, system_prompt_file?}`);模型层用 `profile: <名>` 引用,不配 = 默认全量。小模型省上下文用,详见 §5.8;运行期可前端切换(见 §5.1)。
|
||||
- `model_profiles`(顶层)—— 多套可复用的 prompt+tools 组合(`{tools_allow?, system_prompt_file?}`);模型层用 `profile: <名>` 引用,不配 = 默认全量。内置 `mini`/`zero` 两套默认组合,可用同名覆盖。小模型省上下文用,详见 §5.8;运行期可前端切换(见 §5.1)。
|
||||
- `agent.max_tool_iterations`(默认 20)—— 单轮迭代上限(含工具调用),到顶自动停止并提示用户继续输入。
|
||||
- `terminal.max_output_chars`(默认 10000)—— AI 看到的命令输出上限;executor 侧另有 `EXECUTOR_MAX_OUTPUT_CHARS=200000` 兜底。
|
||||
- `skills.skills_root` —— 缺省取 `workspace_root` 的同级 `skills/`。
|
||||
@@ -711,6 +711,6 @@ sequenceDiagram
|
||||
- `README.md` —— 设计文档(API 设计、SQLite 表结构、任务目录结构、Agent 主循环伪代码、Zed 风格工具定义全集)
|
||||
- `docs/DEPLOY.md` —— 部署(Docker,IP:端口直连;外部网络、配置绝对路径、SSE 缓冲坑)
|
||||
- `docs/v2-develop.md` —— v2 移动单聊视图
|
||||
- `app/config.example.yml` —— 配置模板(每个字段的注释很全)
|
||||
- `app/config.example.yml` —— 配置模板(字段与 `DEFAULTS` 一一对应,每个字段一行注释)
|
||||
- `app/server/templates/system-prompt.txt` —— AI system prompt 全文
|
||||
- `executor/server.js` 头注释 —— executor 协议、安全约束、日志/资源护栏一览
|
||||
|
||||
+16
-26
@@ -14,35 +14,29 @@
|
||||
|
||||
> `config.yml` 与 `.env` 推荐交给 `scripts/init.sh` 生成(见第 0 节);不想用脚本的话也可以自己建(见第 2 节)。
|
||||
|
||||
## 0. 一键生成配置并启动(推荐)
|
||||
## 0. 一键生成配置(推荐)
|
||||
|
||||
`scripts/init.sh` 只读环境变量(不依赖任何外部文件),生成 `.env` 与 `config.yml`,
|
||||
然后按顺序起 agent → mcp:
|
||||
`scripts/init.sh` 只读环境变量(不依赖任何外部文件),生成 `.env` 与 `config.yml`:
|
||||
|
||||
```bash
|
||||
# 什么都不给也能跑:用默认账号 admin/admin、自动探测公网 IP、无模型(platforms: [])
|
||||
# 什么都不给也能跑:默认账号 admin/admin、无模型(platforms: [])
|
||||
./scripts/init.sh
|
||||
|
||||
# 给几个变量
|
||||
BIGMODEL_KEY=xxx DEEPSEEK_KEY=yyy PUBLIC_IP=1.2.3.4 ./scripts/init.sh
|
||||
|
||||
# 只生成 .env / config.yml,不起容器(不装 Docker 的机器也能用)
|
||||
UP=0 ./scripts/init.sh
|
||||
|
||||
# mcp 仓库不在 ../mcp 时指定
|
||||
MCP_DIR=/path/to/mcp ./scripts/init.sh
|
||||
BIGMODEL_KEY=xxx DEEPSEEK_KEY=yyy ZHIPU_KEY=zzz PUBLIC_IP=1.2.3.4 AUTH_USER=me ./scripts/init.sh
|
||||
```
|
||||
|
||||
| 输入变量(均可选) | 说明 |
|
||||
|---|---|
|
||||
| `BIGMODEL_KEY` / `DEEPSEEK_KEY` / `QWEN_KEY` | 模型平台 key,**填几个启用几个**(0~3 个) |
|
||||
| `ZHIPU_KEY` | image-gen / video-gen 用;**留空则这两个服务 `enable: false`**(工具不加载) |
|
||||
| `ZHIPU_KEY` | image_gen / video_gen 用;**留空则这两个服务 `enable: false`**(工具不加载) |
|
||||
| `AUTH_USER` / `AUTH_PASSWORD` | 登录账号(默认 `admin`/`admin`,记得改) |
|
||||
| `PUBLIC_IP` / `AGENT_PORT` | 对外地址与端口(`PUBLIC_IP` 空则尝试自动探测) |
|
||||
| `LOG_LEVEL` | 日志级别(默认 `debug`;日常用 `info`) |
|
||||
| `MCP_DIR` / `UP` | mcp 仓库位置(默认 `../mcp`)/ `UP=0` 只生成配置 |
|
||||
| `PUBLIC_IP` / `AGENT_PORT` | 对外地址与端口,写进 `public_link.base_url`(`PUBLIC_IP` 空则尝试自动探测) |
|
||||
| `AUTH_SECRET` / `EXECUTOR_TOKEN` | 一般不用给:不给就自动生成,并**存在 `.env` 里复用**(所以重跑不会掉登录态) |
|
||||
|
||||
生成的 `config.yml` **只含 deploy 相关段**:`platforms` / `auth` / `mcp_servers` / `public_link`;其余配置项
|
||||
(路径、超时、`model_profiles` 等)走 `server/config.js` 的默认值,完整清单见 `app/config.example.yml`。
|
||||
|
||||
⚠️ **`config.yml` 是生成物,不要再手改**:每次生成都会把旧的备份成 `config.yml.bak.<时间戳>`。
|
||||
要改配置请带环境变量重跑该脚本,或者不用脚本、按第 2 节手动维护。
|
||||
|
||||
@@ -78,28 +72,24 @@ vi .env # 填 EXECUTOR_TOKEN,生成:openssl rand -hex 32
|
||||
vi config.yml
|
||||
```
|
||||
|
||||
`config.yml` 至少改这几处。**容器内必须写绝对路径**——core 与 executor 靠同一份
|
||||
`/workspace/tasks` 看到彼此的产物,留成示例里的相对路径(`./data/tasks`)会解析到
|
||||
`/app/data/tasks`,命令会因为不在 executor 白名单里而失败:
|
||||
`config.example.yml` 与 `server/config.js` 的默认值一一对应,容器内可直接用(路径默认
|
||||
`/workspace/tasks`、`/workspace/data`)。`config.yml` 里至少要配:
|
||||
|
||||
```yaml
|
||||
platforms: ... # 模型池:每个平台 url + keys.api_key
|
||||
workspace_root: /workspace/tasks # 不能留示例里的 ./data/tasks
|
||||
data_root: /workspace/data # SQLite 与 prompt dump 落在这个挂载卷里
|
||||
skills:
|
||||
skills_root: /workspace/skills
|
||||
public_link: # 需要给外部服务公网 URL 时才配(图生视频用);见第 4.1 节
|
||||
base_url: "http://<服务器IP>:8090"
|
||||
platforms: ... # 模型池:每个平台 url + keys.api_key + models.id(必填,不能留空)
|
||||
auth: # 建议启用,否则谁都能访问
|
||||
secret: "换一个随机串"
|
||||
users:
|
||||
- user: admin
|
||||
password: "换一个密码"
|
||||
mcp_servers: # 无域名时按容器名访问(模板已写好,按需启用)
|
||||
- name: web-search
|
||||
- name: web_search
|
||||
url: "http://mcp_web_search:3000/"
|
||||
```
|
||||
|
||||
> `public_link.base_url` 只在需要给外部服务公网 URL(图生视频取参考图)时才配;纯 IP:端口部署
|
||||
> 填 `"http://<服务器IP>:8090"`,容器 env 有 `VIRTUAL_HOST`(nginx-proxy)时以它为准(见第 4.1 节)。
|
||||
|
||||
> ⚠️ 必须先有 `config.yml` 再 `up`:compose 挂载的是 `./config.yml:/app/config.yml`,
|
||||
> 文件不存在时 Docker 会在宿主机建一个同名**目录**,容器起来会读不到配置。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user