diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 0cc5225..88f5e2c 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -24,6 +24,8 @@ agent/ │ ├── Dockerfile node:20-slim,npm install only prod │ ├── package.json 依赖:express / better-sqlite3 / multer / sharp / yaml / minimatch │ ├── config.example.yml 配置模板(被复制为顶层 config.yml) +│ ├── scripts/ +│ │ └── init.sh 部署入口:生成 .env + config.yml → 起 agent/mcp 服务 │ ├── server/ 后端代码 │ │ ├── server.js 入口:装配 cfg / db / bus / engine / 路由 │ │ ├── config.js YAML 配置加载、迁移、读写、校验、脱敏还原 diff --git a/docs/DEPLOY.md b/docs/DEPLOY.md index e4f8afb..71ed6cf 100644 --- a/docs/DEPLOY.md +++ b/docs/DEPLOY.md @@ -9,9 +9,32 @@ | `./tasks/` | `/workspace/tasks` | 任务目录:AI 的文件工作区(与 executor 必须同路径) | | `./data/` | `/workspace/data` | 数据目录 + SQLite(`.agent.db`) | | `./skills/` | `/workspace/skills` | 技能目录:所有任务/会话共享 | -| `./.env` | — | 编排变量(`EXECUTOR_TOKEN` / `AGENT_PORT`),已被 .gitignore 忽略 | +| `./.env` | — | 编排变量(`EXECUTOR_TOKEN` / `AGENT_PORT` / `AUTH_SECRET`),已被 .gitignore 忽略 | +| `./scripts/init.sh` | — | 一键生成上面两个文件并起服务(见第 0 节) | -> 本仓库不含 `config.yml` 与 `.env`,需自行创建(见第 2 步)。 +> `config.yml` 与 `.env` 推荐交给 `scripts/init.sh` 生成(见第 0 节);不想用脚本的话也可以自己建(见第 2 节)。 + +## 0. 一键生成配置并启动(推荐) + +`scripts/init.sh` 读取一组环境变量(通常由服务器上的 `/root/init_repos.sh` 从 `/root/deploy.conf` 传过来), +生成 `.env` 与 `config.yml`,然后按顺序起 agent → mcp: + +```bash +# 直接跑(或在仓库根:./scripts/init.sh) +BIGMODEL_KEY=xxx DEEPSEEK_KEY=yyy PUBLIC_IP=1.2.3.4 ./scripts/init.sh +``` + +| 输入变量 | 说明 | +|---|---| +| `BIGMODEL_KEY` / `DEEPSEEK_KEY` / `QWEN_KEY` | 模型平台 key,**填几个启用几个**(可 0~3 个) | +| `ZHIPU_KEY` | image-gen / video-gen 用;**留空则这两个服务 `enable: false`**(工具不加载) | +| `AUTH_USER` / `AUTH_PASSWORD` | 登录账号(默认 `admin`/`admin`,记得改) | +| `PUBLIC_IP` / `AGENT_PORT` | 对外地址与端口(`PUBLIC_IP` 空则尝试自动探测) | +| `MCP_DIR` | mcp 仓库位置(默认 `../mcp`) | + +自动处理、不用配:`AUTH_SECRET` / `EXECUTOR_TOKEN`(生成一次后存进 `.env`,**重跑保持不变**,所以不会掉登录态)、`LOG_LEVEL`(脚本顶部默认 `debug`,日常改 `info`)。 + +⚠️ **`config.yml` 是生成物,不要再手改**:每次生成都会把旧的备份成 `config.yml.bak.<时间戳>`。要改配置请改上游的 `deploy.conf` 后重跑,或者不用脚本、按第 2 节手动维护。 ## 1. 网络(自动创建,无需手动) @@ -32,7 +55,9 @@ cd ../mcp && docker compose up -d --build > 拆的时候反着来:先 `down` mcp,再 `down` agent。否则 agent 侧会报 > `network my-app-network has active endpoints`(容器照删、网络留下,重新 up 就恢复,不损数据)。 -## 2. 准备配置 +## 2. 准备配置(手动方式) + +不用 `scripts/init.sh` 时,自己建这两个文件: ```bash cp app/config.example.yml config.yml diff --git a/scripts/init.sh b/scripts/init.sh new file mode 100755 index 0000000..18a1fe2 --- /dev/null +++ b/scripts/init.sh @@ -0,0 +1,276 @@ +#!/bin/bash +# 由 /root/init_repos.sh 调用(也可在仓库根直接跑:./scripts/init.sh) +# +# 职责:生成 .env 与 config.yml,然后按序起服务(agent → mcp)。 +# +# 输入(环境变量,通常来自 /root/deploy.conf): +# BIGMODEL_KEY / DEEPSEEK_KEY / QWEN_KEY 模型平台 key,填几个启用几个(可 0~3 个) +# ZHIPU_KEY image-gen / video-gen 的智谱 key(空 = 两个服务 enable: false) +# AUTH_USER / AUTH_PASSWORD 登录账号(默认 admin / admin,请自行改掉) +# PUBLIC_IP / AGENT_PORT 对外地址与端口(PUBLIC_IP 空则尝试自动探测) +# MCP_DIR mcp 仓库位置(默认本仓库同级 ../mcp) +# +# 自动处理(不用配;生成后存进 .env,重跑保持不变,所以不会掉登录态): +# AUTH_SECRET / EXECUTOR_TOKEN / LOG_LEVEL +# +# ⚠️ config.yml 由本脚本生成,不要手改(每次生成前会把旧的备份为 config.yml.bak.<时间戳>)。 +# 要改配置请改 /root/deploy.conf 后重跑 /root/init_repos.sh。 +set -euo pipefail + +REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +cd "$REPO_DIR" + +CONFIG_YML="$REPO_DIR/config.yml" +ENV_FILE="$REPO_DIR/.env" +MCP_DIR="${MCP_DIR:-$(cd "$REPO_DIR/.." && pwd)/mcp}" + +BIGMODEL_KEY="${BIGMODEL_KEY:-}" +DEEPSEEK_KEY="${DEEPSEEK_KEY:-}" +QWEN_KEY="${QWEN_KEY:-}" +ZHIPU_KEY="${ZHIPU_KEY:-}" +AUTH_USER="${AUTH_USER:-admin}" +AUTH_PASSWORD="${AUTH_PASSWORD:-admin}" +PUBLIC_IP="${PUBLIC_IP:-}" +AGENT_PORT="${AGENT_PORT:-8090}" +LOG_LEVEL="${LOG_LEVEL:-debug}" # 测试期默认 debug(打印 AI↔工具完整交互);日常用 info +EXECUTOR_TOKEN="${EXECUTOR_TOKEN:-}" +AUTH_SECRET="${AUTH_SECRET:-}" + +log() { echo -e "\n\033[1;32m===== $* =====\033[0m"; } +info() { echo -e "\033[1;36m[INFO]\033[0m $*"; } +warn() { echo -e "\033[1;33m[WARN]\033[0m $*"; } +err() { echo -e "\033[1;31m[ERROR]\033[0m $*"; } + +# ============================================================ +# 1. 环境检查 +# ============================================================ +if ! command -v docker >/dev/null 2>&1 || ! docker compose version >/dev/null 2>&1; then + err "docker / docker compose 不可用。请先跑 /root/init.sh 完成服务器初始化。" + exit 1 +fi + +gen_hex() { # $1 = 字节数(默认 32) + local n="${1:-32}" + if command -v openssl >/dev/null 2>&1; then + openssl rand -hex "$n" + else + head -c "$n" /dev/urandom | od -An -tx1 | tr -d ' \n' + fi +} + +# ============================================================ +# 2. 生成 .env(密钥只生成一次,之后复用 → 重跑不掉登录态、不改 executor token) +# ============================================================ +log "生成 $ENV_FILE" + +if [ -f "$ENV_FILE" ]; then + EXECUTOR_TOKEN="${EXECUTOR_TOKEN:-$(sed -n 's/^EXECUTOR_TOKEN=//p' "$ENV_FILE" | head -1)}" + AUTH_SECRET="${AUTH_SECRET:-$(sed -n 's/^AUTH_SECRET=//p' "$ENV_FILE" | head -1)}" +fi +EXECUTOR_TOKEN="${EXECUTOR_TOKEN:-$(gen_hex 32)}" +AUTH_SECRET="${AUTH_SECRET:-$(gen_hex 32)}" + +cat > "$ENV_FILE" </dev/null 2>&1; then + PUBLIC_IP="$(curl -fsS --max-time 5 "$u" 2>/dev/null || true)" + [ -n "$PUBLIC_IP" ] && break + fi + done +fi +if [ -z "$PUBLIC_IP" ]; then + warn "探测不到公网 IP:public_link 不生效(图生视频用不了)。请在 deploy.conf 里填 PUBLIC_IP 后重跑。" +fi + +# ============================================================ +# 3. 生成 config.yml +# ============================================================ +log "生成 $CONFIG_YML" + +if [ -f "$CONFIG_YML" ]; then + cp "$CONFIG_YML" "$CONFIG_YML.bak.$(date +%s)" + info "旧 config.yml 已备份为 config.yml.bak.<时间戳>" +fi + +# 单个平台骨架(url / 模型 / 参数固定,只有 key 来自配置) +emit_platform() { + case "$1" in + bigmodel) + cat < "$CONFIG_YML" + +info "平台: ${enabled_plats[*]:-无};智谱 MCP: $([ -n "$ZHIPU_KEY" ] && echo 启用 || echo 未配置)" + +# ============================================================ +# 4. 起服务(顺序:agent 先起,它创建 my-app-network) +# ============================================================ +log "启动 agent" +docker compose up -d --build + +if [ -d "$MCP_DIR" ]; then + log "启动 mcp($MCP_DIR)" + ( cd "$MCP_DIR" && docker compose up -d --build ) +else + warn "没找到 mcp 仓库($MCP_DIR),跳过。" +fi + +# ============================================================ +# 5. 汇总 +# ============================================================ +log "汇总" +echo "---------------------------------------------" +echo " 访问地址 : http://${PUBLIC_IP:-<公网IP>}:${AGENT_PORT}" +echo " 账号 : $AUTH_USER" +echo " 密码 : $AUTH_PASSWORD" +echo " 平台 : ${enabled_plats[*]:-(无,去 /root/deploy.conf 填 key)}" +echo " 智谱 MCP : $([ -n "$ZHIPU_KEY" ] && echo "image-gen / video-gen 已启用" || echo "未配置(enable: false)")" +echo " 日志级别 : $LOG_LEVEL" +echo "---------------------------------------------" +echo +info "容器状态:" +docker compose ps +if [ -d "$MCP_DIR" ]; then + ( cd "$MCP_DIR" && docker compose ps ) +fi + +echo +info "看日志: docker compose logs -f agent-core" +info "自检(期望 400 缺 path 参数,说明签发链路通了):" +info " docker exec mcp_video_gen node -e \"fetch('http://agent-core:8081/public-link').then(async r=>console.log(r.status, await r.text()))\"" +info "注意:安全组/防火墙需放行 ${AGENT_PORT}(mcp 三个服务一律不用放行)" +log "完成 ✅"