From b816efc23f3f724bdfde96200239e0b133730dd2 Mon Sep 17 00:00:00 2001 From: kicer Date: Mon, 31 Aug 2026 08:42:16 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9C=AC=E5=9C=B0=E9=83=A8=E7=BD=B2=EF=BC=9A?= =?UTF-8?q?=E9=A1=B6=E5=B1=82=20docker-compose/config=EF=BC=8C=E5=9F=9F?= =?UTF-8?q?=E5=90=8D=20agent.ai.foresh.com=EF=BC=88nginx-proxy=20VIRTUAL?= =?UTF-8?q?=5FHOST=20+=20external=20my-app-network=EF=BC=8C=E4=BB=85?= =?UTF-8?q?=E5=86=85=E7=BD=91=20expose=208080=EF=BC=8Cconfig=20=E5=8F=AA?= =?UTF-8?q?=E8=AF=BB=E6=8C=82=E8=BD=BD=EF=BC=89=EF=BC=9B=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E5=90=8E=E7=BC=80=E7=BB=9F=E4=B8=80=20.yaml=E2=86=92.yml?= =?UTF-8?q?=EF=BC=88=E6=96=87=E4=BB=B6=E4=B8=8E=E5=85=A8=E9=83=A8=E5=BC=95?= =?UTF-8?q?=E7=94=A8=EF=BC=8C=E5=90=AB=20Dockerfile/AGENT=5FCONFIG/config.?= =?UTF-8?q?js/smoke=EF=BC=89=E3=80=82smoke=2025/25=20=E9=80=9A=E8=BF=87?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 3 +- README.md | 34 ++++--- app/Dockerfile | 4 +- app/README.md | 6 +- ...config.example.yaml => config.example.yml} | 2 +- app/docker-compose.yml | 11 --- app/server/config.js | 4 +- app/server/tools/executor.js | 2 +- .../{config.test.yaml => config.test.yml} | 0 app/test/smoke.js | 2 +- docker-compose.yml | 21 +++++ docs/DEPLOY.md | 89 ++++++++----------- 12 files changed, 92 insertions(+), 86 deletions(-) rename app/{config.example.yaml => config.example.yml} (92%) delete mode 100644 app/docker-compose.yml rename app/test/{config.test.yaml => config.test.yml} (100%) create mode 100644 docker-compose.yml diff --git a/.gitignore b/.gitignore index e88089d..bc8986b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,8 @@ /zed_agent/ node_modules/ app/test/tmp/ -app/config.yaml +app/config.yml +/config.yml app/data/ data/ *.log diff --git a/README.md b/README.md index c067a80..e6ffdfb 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ### 2.1 模型池配置 -配置文件(如 `config.yaml`)中定义模型列表: +配置文件(如 `config.yml`)中定义模型列表: ```yaml models: @@ -954,25 +954,35 @@ function runAgent(session): ## 十三、Docker 部署 -### 13.1 Docker Compose 示例 +### 13.1 Docker Compose(顶层 `docker-compose.yml`) ```yaml services: agent: - build: . - ports: - - "8080:8080" - volumes: - - ./data:/workspace/tasks - - ./config.yaml:/app/config.yaml - environment: - - AGENT_CONFIG=/app/config.yaml + build: ./app restart: unless-stopped + expose: + - "8080" # 仅内网暴露,由 nginx-proxy 对外 + volumes: + - ./data:/workspace/tasks # 持久化:任务目录 + SQLite + - ./config.yml:/app/config.yml:ro + environment: + - PORT=8080 + - AGENT_CONFIG=/app/config.yml + - VIRTUAL_HOST=agent.ai.foresh.com + - VIRTUAL_PORT=8080 + - CERT_NAME=default + networks: + - my-app-network + +networks: + my-app-network: + external: true ``` -### 13.2 nginx-proxy basic auth +### 13.2 nginx-proxy 对外暴露 -前置 nginx-proxy,配置 basic auth,多个用户共享同一认证,不做任务隔离。 +前置的 nginx-proxy 需与业务容器共用外部网络 `my-app-network`。compose 通过 `VIRTUAL_HOST`/`VIRTUAL_PORT`/`CERT_NAME` 接入;域名 `agent.ai.foresh.com` 的 DNS 指向 nginx-proxy 所在宿主机。多个用户共享同一认证,不做任务隔离;SSE 需关代理缓冲(`proxy_buffering off`),见 `docs/DEPLOY.md`。 --- diff --git a/app/Dockerfile b/app/Dockerfile index 9502ef4..1b95ec9 100644 --- a/app/Dockerfile +++ b/app/Dockerfile @@ -11,9 +11,9 @@ COPY package.json package-lock.json ./ RUN npm install --omit=dev --no-audit --no-fund COPY server ./server -COPY config.example.yaml ./ +COPY config.example.yml ./ EXPOSE 8080 -ENV AGENT_CONFIG=/app/config.yaml +ENV AGENT_CONFIG=/app/config.yml CMD ["node", "server/server.js"] diff --git a/app/README.md b/app/README.md index 38c71cf..a520b97 100644 --- a/app/README.md +++ b/app/README.md @@ -8,7 +8,7 @@ app/ ├── server/ │ ├── server.js # 入口:装配配置/DB/总线/路由/静态资源 -│ ├── config.js # config.yaml 加载与校验 +│ ├── config.js # config.yml 加载与校验 │ ├── db.js # SQLite(better-sqlite3,WAL) │ ├── engine.js # 会话管理 + 模型池 FIFO 调度 + Agent 主循环 │ ├── llm.js # OpenAI 兼容上游流式调用(SSE 解析/工具分片合并) @@ -24,7 +24,7 @@ app/ │ └── public/ # H5 前端(Vanilla JS + SSE) ├── test/ # mock 上游 + 端到端冒烟测试 ├── scripts(在上层仓库根目录)gen-from-readme.js # README → 提示词/工具 schema -├── config.example.yaml +├── config.example.yml ├── Dockerfile / docker-compose.yml ``` @@ -33,7 +33,7 @@ app/ ```bash cd app npm install -cp config.example.yaml config.yaml # 修改 upstream_url / models +cp config.example.yml config.yml # 修改 upstream_url / models npm start # http://localhost:8080 ``` diff --git a/app/config.example.yaml b/app/config.example.yml similarity index 92% rename from app/config.example.yaml rename to app/config.example.yml index 657a151..3352249 100644 --- a/app/config.example.yaml +++ b/app/config.example.yml @@ -1,5 +1,5 @@ # 自用通用 Agent 系统配置示例 -# 复制为 config.yaml 后按需修改;容器内通过 AGENT_CONFIG 指定路径。 +# 复制为 config.yml 后按需修改;容器内通过 AGENT_CONFIG 指定路径。 # 模型池:多个 ID 共用同一个上游 URL(cli-proxy-api 按 ID 路由到不同账号)。 # 同时活跃会话数上限 = 模型数量。 diff --git a/app/docker-compose.yml b/app/docker-compose.yml deleted file mode 100644 index 4caf788..0000000 --- a/app/docker-compose.yml +++ /dev/null @@ -1,11 +0,0 @@ -services: - agent: - build: . - ports: - - "8080:8080" - volumes: - - ./data:/workspace/tasks - - ./config.yaml:/app/config.yaml:ro - environment: - - AGENT_CONFIG=/app/config.yaml - restart: unless-stopped diff --git a/app/server/config.js b/app/server/config.js index 4e25e99..8d7f46d 100644 --- a/app/server/config.js +++ b/app/server/config.js @@ -1,4 +1,4 @@ -// 配置加载:AGENT_CONFIG 指向 config.yaml(见 config.example.yaml) +// 配置加载:AGENT_CONFIG 指向 config.yml(见 config.example.yml) const fs = require('fs'); const path = require('path'); const YAML = require('yaml'); @@ -33,7 +33,7 @@ function deepMerge(base, extra) { } function loadConfig(configPath) { - const p = configPath || process.env.AGENT_CONFIG || path.join(__dirname, '..', 'config.yaml'); + const p = configPath || process.env.AGENT_CONFIG || path.join(__dirname, '..', 'config.yml'); let raw = {}; if (fs.existsSync(p)) { raw = YAML.parse(fs.readFileSync(p, 'utf8')) || {}; diff --git a/app/server/tools/executor.js b/app/server/tools/executor.js index d5d4e8b..96f9341 100644 --- a/app/server/tools/executor.js +++ b/app/server/tools/executor.js @@ -619,7 +619,7 @@ function strip(s) { return s.replace(/<[^>]+>/g, ''); } // web_search:调用内网 MCP 服务(JSON-RPC over HTTP,无状态,响应为 SSE 帧包裹的 JSON)。 async function toolWebSearch(ctx, args) { const ws = ctx.cfg.web_search || {}; - if (!ws.url) return 'web_search 未配置:请在 config.yaml 的 web_search.url 中填写 MCP 服务地址'; + if (!ws.url) return 'web_search 未配置:请在 config.yml 的 web_search.url 中填写 MCP 服务地址'; const query = args.query; if (!query) return 'web_search 缺少参数 query'; const callId = Date.now(); diff --git a/app/test/config.test.yaml b/app/test/config.test.yml similarity index 100% rename from app/test/config.test.yaml rename to app/test/config.test.yml diff --git a/app/test/smoke.js b/app/test/smoke.js index 815aee0..8b1636a 100644 --- a/app/test/smoke.js +++ b/app/test/smoke.js @@ -46,7 +46,7 @@ async function main() { const mock = spawn('node', [path.join(ROOT, 'test/mock-upstream.js')], { stdio: 'inherit' }); const server = spawn('node', [path.join(ROOT, 'server/server.js')], { cwd: ROOT, - env: Object.assign({}, process.env, { AGENT_CONFIG: path.join(ROOT, 'test/config.test.yaml') }), + env: Object.assign({}, process.env, { AGENT_CONFIG: path.join(ROOT, 'test/config.test.yml') }), stdio: ['ignore', 'pipe', 'pipe'], }); let serverLog = ''; diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..697b9fe --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,21 @@ +services: + agent: + build: ./app + restart: unless-stopped + expose: + - "8080" # 仅内网暴露,由 nginx-proxy 对外 + volumes: + - ./data:/workspace/tasks # 持久化:任务目录 + SQLite(.agent.db 在此目录内) + - ./config.yml:/app/config.yml:ro + environment: + - PORT=8080 + - AGENT_CONFIG=/app/config.yml + - VIRTUAL_HOST=agent.ai.foresh.com + - VIRTUAL_PORT=8080 + - CERT_NAME=default + networks: + - my-app-network + +networks: + my-app-network: + external: true \ No newline at end of file diff --git a/docs/DEPLOY.md b/docs/DEPLOY.md index 403aca1..a3b9c78 100644 --- a/docs/DEPLOY.md +++ b/docs/DEPLOY.md @@ -1,74 +1,59 @@ -# 部署说明(Docker + nginx-proxy basic auth) +# 部署说明(Docker + nginx-proxy,域名 agent.ai.foresh.com) + +配置与编排文件都放在**仓库顶层**,方便直接调整: + +| 宿主机路径 | 容器内路径 | 说明 | +|---|---|---| +| `./docker-compose.yml` | — | 编排(构建 `./app`,仅内网 expose 8080) | +| `./config.yml` | `/app/config.yml` | 运行配置(AGENT_CONFIG 指向它;含密钥,已被 .gitignore 忽略) | +| `./data/` | `/workspace/tasks` | 任务目录 + SQLite(`.agent.db` 在此目录内) | ## 1. 准备配置 ```bash -cd app -cp config.example.yaml config.yaml -vi config.yaml # 至少改 upstream_url 与 models +cp app/config.example.yml config.yml +vi config.yml # 至少改 upstream_url 与 models ``` -容器内运行时约定(docker-compose.yml 已按此挂载): - -| 宿主机路径 | 容器内路径 | 说明 | -|---|---|---| -| `./config.yaml` | `/app/config.yaml` | 运行配置(AGENT_CONFIG 指向它) | -| `./data/` | `/workspace/tasks` | 任务目录 + SQLite(`.agent.db` 在此目录内) | - -> 注意:容器内运行时 `workspace_root` 请写 `/workspace/tasks`(宿主机直接运行则用默认 `./data/tasks` 即可)。 +> 容器内运行时 `workspace_root` 写 `/workspace/tasks`(docker-compose.yml 已把 `./data` 挂到这里)。 +> 本仓库 git 只跟踪示例 `app/config.example.yml`,真正的 `config.yml` 在顶层且被忽略,密钥不会进库。 ## 2. 构建并启动 ```bash -cd app +# 在仓库顶层(含 docker-compose.yml 的位置)执行 docker compose up -d --build -docker compose logs -f # 看到 "Agent server listening on 8080" 即成功 +docker compose logs -f # 看到 "Agent server listening on 8080" 即成功 ``` -## 3. nginx-proxy + basic auth +## 3. nginx-proxy 对外暴露(agent.ai.foresh.com) -多用户共享一套认证,不做任务隔离(见 README 8.1)。 +compose 已通过 `VIRTUAL_HOST` / `VIRTUAL_PORT` / `CERT_NAME` 接入 nginx-proxy: -生成密码文件(需 apache2-utils 提供的 htpasswd): - -```bash -apt-get install apache2-utils # 或任何能生成 htpasswd 的方式 -htpasswd -c ./deploy/.htpasswd admin -htpasswd ./deploy/.htpasswd user2 -``` - -nginx 站点配置: - -```nginx -server { - listen 80; - server_name agent.example.com; - - location / { - auth_basic "Agent"; - auth_basic_user_file /etc/nginx/.htpasswd; - - proxy_pass http://agent:8080; - proxy_http_version 1.1; - proxy_buffering off; # SSE 必须关缓冲 - proxy_read_timeout 3600s; # 长连接不被掐断 - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - } -} -``` - -> SSE 关键点:`proxy_buffering off`,否则流式输出会被 nginx 攒着不发。 - -若不想用 nginx,也可直接启用内置认证:在 `config.yaml` 里配置 -`auth: {user: admin, password: ...}`(仅适合纯内网测试;上游仍建议 nginx TLS)。 +- 前置的 nginx-proxy 容器必须与业务容器共用同一个外部网络 `my-app-network`(compose 声明为 external),并监听 80/443。 +- 域名 `agent.ai.foresh.com` 的 DNS 指向 nginx-proxy 所在宿主机。 +- 若你的 nginx-proxy 未默认关闭代理缓冲,需额外配置 `proxy_buffering off`——**SSE 必须关缓冲**,否则流式输出会被攒住不发。可给 nginx-proxy 挂一个自定义 conf: + ``` + server { + listen 80; + server_name agent.ai.foresh.com; + location / { + proxy_pass http://agent:8080; + proxy_http_version 1.1; + proxy_buffering off; # SSE 关键 + proxy_read_timeout 3600s; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } + } + ``` +- 认证交给 nginx-proxy(htpasswd)或在此 config 里启用内置 `auth`(见 config.example.yml 注释),二选一即可。 ## 4. 升级流程 ```bash git pull -cd app && docker compose up -d --build +docker compose up -d --build # 仓库顶层执行 ``` -数据库与任务目录都在 volume 内,升级不丢数据。进程重启时,原 active 会话 -会自动退回排队队列,待模型空闲后继续。 +数据库与任务目录都在 volume 内,升级不丢数据。进程重启时,原 active 会话会自动退回排队队列,待模型空闲后继续。 \ No newline at end of file