@symerian/symi 3.0.20 → 3.0.22

package/docs/zh-CN/install/gcp.md

@@ -1,509 +0,0 @@
----
-read_when:
-  - 你想在 GCP 上 24/7 运行 Symi
-  - 你想要在自己的 VM 上运行生产级、常驻的 Gateway 网关
-  - 你想完全控制持久化、二进制文件和重启行为
-summary: 在 GCP Compute Engine VM（Docker）上 24/7 运行 Symi Gateway 网关并持久化状态
-title: GCP
-x-i18n:
-  generated_at: "2026-02-03T07:52:50Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: abb236dd421505d307bb3869340c9a0c940de095b93af9ad1f130cc08a9deadb
-  source_path: platforms/gcp.md
-  workflow: 15
----
-
-# 在 GCP Compute Engine 上运行 Symi（Docker，生产 VPS 指南）
-
-## 目标
-
-使用 Docker 在 GCP Compute Engine VM 上运行持久化的 Symi Gateway 网关，具有持久状态、内置二进制文件和安全的重启行为。
-
-如果你想要"Symi 24/7 大约 $5-12/月"，这是在 Google Cloud 上的可靠设置。
-价格因机器类型和区域而异；选择适合你工作负载的最小 VM，如果遇到 OOM 则扩容。
-
-## 我们在做什么（简单说明）？
-
-- 创建 GCP 项目并启用计费
-- 创建 Compute Engine VM
-- 安装 Docker（隔离的应用运行时）
-- 在 Docker 中启动 Symi Gateway 网关
-- 在主机上持久化 `~/.symi` + `~/.symi/workspace`（重启/重建后仍保留）
-- 通过 SSH 隧道从你的笔记本电脑访问控制 UI
-
-Gateway 网关可以通过以下方式访问：
-
-- 从你的笔记本电脑进行 SSH 端口转发
-- 如果你自己管理防火墙和令牌，可以直接暴露端口
-
-本指南使用 GCP Compute Engine 上的 Debian。
-Ubuntu 也可以；请相应地映射软件包。
-有关通用 Docker 流程，请参阅 [Docker](/install/docker)。
-
----
-
-## 快速路径（有经验的运维人员）
-
-1. 创建 GCP 项目 + 启用 Compute Engine API
-2. 创建 Compute Engine VM（e2-small，Debian 12，20GB）
-3. SSH 进入 VM
-4. 安装 Docker
-5. 克隆 Symi 仓库
-6. 创建持久化主机目录
-7. 配置 `.env` 和 `docker-compose.yml`
-8. 内置所需二进制文件、构建并启动
-
----
-
-## 你需要什么
-
-- GCP 账户（e2-micro 符合免费层条件）
-- 已安装 gcloud CLI（或使用 Cloud Console）
-- 从你的笔记本电脑 SSH 访问
-- 对 SSH + 复制/粘贴有基本了解
-- 约 20-30 分钟
-- Docker 和 Docker Compose
-- 模型认证凭证
-- 可选的提供商凭证
-  - WhatsApp QR
-  - Telegram bot token
-  - Gmail OAuth
-
----
-
-## 1) 安装 gcloud CLI（或使用 Console）
-
-**选项 A：gcloud CLI**（推荐用于自动化）
-
-从 https://cloud.google.com/sdk/docs/install 安装
-
-初始化并认证：
-
-```bash
-gcloud init
-gcloud auth login
-```
-
-**选项 B：Cloud Console**
-
-所有步骤都可以通过 https://console.cloud.google.com 的 Web UI 完成
-
----
-
-## 2) 创建 GCP 项目
-
-**CLI：**
-
-```bash
-gcloud projects create my-symi-project --name="Symi Gateway"
-gcloud config set project my-symi-project
-```
-
-在 https://console.cloud.google.com/billing 启用计费（Compute Engine 必需）。
-
-启用 Compute Engine API：
-
-```bash
-gcloud services enable compute.googleapis.com
-```
-
-**Console：**
-
-1. 转到 IAM & Admin > Create Project
-2. 命名并创建
-3. 为项目启用计费
-4. 导航到 APIs & Services > Enable APIs > 搜索 "Compute Engine API" > Enable
-
----
-
-## 3) 创建 VM
-
-**机器类型：**
-
-| 类型     | 配置                    | 成本       | 说明           |
-| -------- | ----------------------- | ---------- | -------------- |
-| e2-small | 2 vCPU，2GB RAM         | ~$12/月    | 推荐           |
-| e2-micro | 2 vCPU（共享），1GB RAM | 符合免费层 | 负载下可能 OOM |
-
-**CLI：**
-
-```bash
-gcloud compute instances create symi-gateway \
-  --zone=us-central1-a \
-  --machine-type=e2-small \
-  --boot-disk-size=20GB \
-  --image-family=debian-12 \
-  --image-project=debian-cloud
-```
-
-**Console：**
-
-1. 转到 Compute Engine > VM instances > Create instance
-2. Name：`symi-gateway`
-3. Region：`us-central1`，Zone：`us-central1-a`
-4. Machine type：`e2-small`
-5. Boot disk：Debian 12，20GB
-6. Create
-
----
-
-## 4) SSH 进入 VM
-
-**CLI：**
-
-```bash
-gcloud compute ssh symi-gateway --zone=us-central1-a
-```
-
-**Console：**
-
-在 Compute Engine 仪表板中点击 VM 旁边的"SSH"按钮。
-
-注意：VM 创建后 SSH 密钥传播可能需要 1-2 分钟。如果连接被拒绝，请等待并重试。
-
----
-
-## 5) 安装 Docker（在 VM 上）
-
-```bash
-sudo apt-get update
-sudo apt-get install -y git curl ca-certificates
-curl -fsSL https://get.docker.com | sudo sh
-sudo usermod -aG docker $USER
-```
-
-注销并重新登录以使组更改生效：
-
-```bash
-exit
-```
-
-然后重新 SSH 登录：
-
-```bash
-gcloud compute ssh symi-gateway --zone=us-central1-a
-```
-
-验证：
-
-```bash
-docker --version
-docker compose version
-```
-
----
-
-## 6) 克隆 Symi 仓库
-
-```bash
-git clone https://github.com/symi/symi.git
-cd symi
-```
-
-本指南假设你将构建自定义镜像以保证二进制文件持久化。
-
----
-
-## 7) 创建持久化主机目录
-
-Docker 容器是临时的。
-所有长期状态必须存在于主机上。
-
-```bash
-mkdir -p ~/.symi
-mkdir -p ~/.symi/workspace
-```
-
----
-
-## 8) 配置环境变量
-
-在仓库根目录创建 `.env`。
-
-```bash
-SYMI_IMAGE=symi:latest
-SYMI_GATEWAY_TOKEN=change-me-now
-SYMI_GATEWAY_BIND=lan
-SYMI_GATEWAY_PORT=18789
-
-SYMI_CONFIG_DIR=/home/$USER/.symi
-SYMI_WORKSPACE_DIR=/home/$USER/.symi/workspace
-
-GOG_KEYRING_PASSWORD=change-me-now
-XDG_CONFIG_HOME=/home/node/.symi
-```
-
-生成强密钥：
-
-```bash
-openssl rand -hex 32
-```
-
-**不要提交此文件。**
-
----
-
-## 9) Docker Compose 配置
-
-创建或更新 `docker-compose.yml`。
-
-```yaml
-services:
-  symi-gateway:
-    image: ${SYMI_IMAGE}
-    build: .
-    restart: unless-stopped
-    env_file:
-      - .env
-    environment:
-      - HOME=/home/node
-      - NODE_ENV=production
-      - TERM=xterm-256color
-      - SYMI_GATEWAY_BIND=${SYMI_GATEWAY_BIND}
-      - SYMI_GATEWAY_PORT=${SYMI_GATEWAY_PORT}
-      - SYMI_GATEWAY_TOKEN=${SYMI_GATEWAY_TOKEN}
-      - GOG_KEYRING_PASSWORD=${GOG_KEYRING_PASSWORD}
-      - XDG_CONFIG_HOME=${XDG_CONFIG_HOME}
-      - PATH=/home/linuxbrew/.linuxbrew/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
-    volumes:
-      - ${SYMI_CONFIG_DIR}:/home/node/.symi
-      - ${SYMI_WORKSPACE_DIR}:/home/node/.symi/workspace
-    ports:
-      # 推荐：在 VM 上保持 Gateway 网关仅绑定 loopback；通过 SSH 隧道访问。
-      # 要公开暴露，移除 `127.0.0.1:` 前缀并相应配置防火墙。
-      - "127.0.0.1:${SYMI_GATEWAY_PORT}:18789"
-
-      # 可选：仅当你针对此 VM 运行 iOS/Android 节点并需要 Canvas 主机时。
-      # 如果你公开暴露此端口，请阅读 /gateway/security 并相应配置防火墙。
-      # - "18793:18793"
-    command:
-      [
-        "node",
-        "dist/index.js",
-        "gateway",
-        "--bind",
-        "${SYMI_GATEWAY_BIND}",
-        "--port",
-        "${SYMI_GATEWAY_PORT}",
-      ]
-```
-
----
-
-## 10) 将所需二进制文件内置到镜像中（关键）
-
-在运行中的容器内安装二进制文件是一个陷阱。
-任何在运行时安装的内容在重启后都会丢失。
-
-所有 Skills 所需的外部二进制文件必须在镜像构建时安装。
-
-以下示例仅显示三个常见的二进制文件：
-
-- `gog` 用于 Gmail 访问
-- `goplaces` 用于 Google Places
-- `wacli` 用于 WhatsApp
-
-这些是示例，不是完整列表。
-你可以使用相同的模式安装任意数量的二进制文件。
-
-如果你以后添加依赖额外二进制文件的新 Skills，你必须：
-
-1. 更新 Dockerfile
-2. 重建镜像
-3. 重启容器
-
-**示例 Dockerfile**
-
-```dockerfile
-FROM node:22-bookworm
-
-RUN apt-get update && apt-get install -y socat && rm -rf /var/lib/apt/lists/*
-
-# 示例二进制文件 1：Gmail CLI
-RUN curl -L https://github.com/steipete/gog/releases/latest/download/gog_Linux_x86_64.tar.gz \
-  | tar -xz -C /usr/local/bin && chmod +x /usr/local/bin/gog
-
-# 示例二进制文件 2：Google Places CLI
-RUN curl -L https://github.com/steipete/goplaces/releases/latest/download/goplaces_Linux_x86_64.tar.gz \
-  | tar -xz -C /usr/local/bin && chmod +x /usr/local/bin/goplaces
-
-# 示例二进制文件 3：WhatsApp CLI
-RUN curl -L https://github.com/steipete/wacli/releases/latest/download/wacli_Linux_x86_64.tar.gz \
-  | tar -xz -C /usr/local/bin && chmod +x /usr/local/bin/wacli
-
-# 使用相同的模式在下面添加更多二进制文件
-
-WORKDIR /app
-COPY package.json pnpm-lock.yaml pnpm-workspace.yaml .npmrc ./
-COPY scripts ./scripts
-
-RUN corepack enable
-RUN pnpm install --frozen-lockfile
-
-COPY . .
-RUN pnpm build
-RUN pnpm ui:install
-RUN pnpm ui:build
-
-ENV NODE_ENV=production
-
-CMD ["node","dist/index.js"]
-```
-
----
-
-## 11) 构建并启动
-
-```bash
-docker compose build
-docker compose up -d symi-gateway
-```
-
-验证二进制文件：
-
-```bash
-docker compose exec symi-gateway which gog
-docker compose exec symi-gateway which goplaces
-docker compose exec symi-gateway which wacli
-```
-
-预期输出：
-
-```
-/usr/local/bin/gog
-/usr/local/bin/goplaces
-/usr/local/bin/wacli
-```
-
----
-
-## 12) 验证 Gateway 网关
-
-```bash
-docker compose logs -f symi-gateway
-```
-
-成功：
-
-```
-[gateway] listening on ws://0.0.0.0:18789
-```
-
----
-
-## 13) 从你的笔记本电脑访问
-
-创建 SSH 隧道以转发 Gateway 网关端口：
-
-```bash
-gcloud compute ssh symi-gateway --zone=us-central1-a -- -L 18789:127.0.0.1:18789
-```
-
-在浏览器中打开：
-
-`http://127.0.0.1:18789/`
-
-粘贴你的 Gateway 网关令牌。
-
----
-
-## 什么持久化在哪里（真实来源）
-
-Symi 在 Docker 中运行，但 Docker 不是真实来源。
-所有长期状态必须在重启、重建和重启后仍然存在。
-
-| 组件             | 位置                          | 持久化机制    | 说明                        |
-| ---------------- | ----------------------------- | ------------- | --------------------------- |
-| Gateway 网关配置 | `/home/node/.symi/`           | 主机卷挂载    | 包括 `symi.json`、令牌      |
-| 模型认证配置文件 | `/home/node/.symi/`           | 主机卷挂载    | OAuth 令牌、API 密钥        |
-| Skill 配置       | `/home/node/.symi/skills/`    | 主机卷挂载    | Skill 级别状态              |
-| 智能体工作区     | `/home/node/.symi/workspace/` | 主机卷挂载    | 代码和智能体产物            |
-| WhatsApp 会话    | `/home/node/.symi/`           | 主机卷挂载    | 保留 QR 登录                |
-| Gmail 密钥环     | `/home/node/.symi/`           | 主机卷 + 密码 | 需要 `GOG_KEYRING_PASSWORD` |
-| 外部二进制文件   | `/usr/local/bin/`             | Docker 镜像   | 必须在构建时内置            |
-| Node 运行时      | 容器文件系统                  | Docker 镜像   | 每次镜像构建时重建          |
-| OS 包            | 容器文件系统                  | Docker 镜像   | 不要在运行时安装            |
-| Docker 容器      | 临时                          | 可重启        | 可以安全销毁                |
-
----
-
-## 更新
-
-在 VM 上更新 Symi：
-
-```bash
-cd ~/symi
-git pull
-docker compose build
-docker compose up -d
-```
-
----
-
-## 故障排除
-
-**SSH 连接被拒绝**
-
-VM 创建后 SSH 密钥传播可能需要 1-2 分钟。等待并重试。
-
-**OS Login 问题**
-
-检查你的 OS Login 配置文件：
-
-```bash
-gcloud compute os-login describe-profile
-```
-
-确保你的账户具有所需的 IAM 权限（Compute OS Login 或 Compute OS Admin Login）。
-
-**内存不足（OOM）**
-
-如果使用 e2-micro 并遇到 OOM，升级到 e2-small 或 e2-medium：
-
-```bash
-# 首先停止 VM
-gcloud compute instances stop symi-gateway --zone=us-central1-a
-
-# 更改机器类型
-gcloud compute instances set-machine-type symi-gateway \
-  --zone=us-central1-a \
-  --machine-type=e2-small
-
-# 启动 VM
-gcloud compute instances start symi-gateway --zone=us-central1-a
-```
-
----
-
-## 服务账户（安全最佳实践）
-
-对于个人使用，你的默认用户账户就可以。
-
-对于自动化或 CI/CD 管道，创建具有最小权限的专用服务账户：
-
-1. 创建服务账户：
-
-   ```bash
-   gcloud iam service-accounts create symi-deploy \
-     --display-name="Symi Deployment"
-   ```
-
-2. 授予 Compute Instance Admin 角色（或更窄的自定义角色）：
-   ```bash
-   gcloud projects add-iam-policy-binding my-symi-project \
-     --member="serviceAccount:symi-deploy@my-symi-project.iam.gserviceaccount.com" \
-     --role="roles/compute.instanceAdmin.v1"
-   ```
-
-避免为自动化使用 Owner 角色。使用最小权限原则。
-
-参阅 https://cloud.google.com/iam/docs/understanding-roles 了解 IAM 角色详情。
-
----
-
-## 下一步
-
-- 设置消息渠道：[渠道](/channels)
-- 将本地设备配对为节点：[节点](/nodes)
-- 配置 Gateway 网关：[Gateway 网关配置](/gateway/configuration)