中EN GitHub

私有部署

部署在你们自己手里

SuDuo 不提供托管服务。团队在自己的 Linux 服务器上装一套服务端，每个人在自己电脑上运行客户端；代码仓库、Codex 会话和模型凭据留在各自的电脑上，中间没有任何 SuDuo 的服务。

开始部署服务端部署指南

团队服务器

每个团队装一次

保存项目、需求、评论、附件和讨论房间。一台装有 Docker 的 Linux 服务器，一个脚本装好。

每个人的电脑

每人装一次

运行 SuDuo 客户端和 Codex CLI。代码仓库、Codex 会话和模型凭据都留在这里。

系统要求

团队服务器
  • Ubuntu 22.04 或 24.04（x86_64）：正式支持；其他装了 Docker 的 Linux 发行版（含 arm64）尽力支持
  • 至少 2 核 CPU、4 GB 内存、20 GB 磁盘
  • Docker Engine 与 Compose 插件，以及 git
  • 构建时要能访问 Docker Hub 和 npm，或你能访问的镜像源；团队成员要能访问服务端口（默认 4100）
每个人的电脑
  • macOS 13.5 或更新（Apple 芯片或 Intel），或 Windows 10 / 11（x64）
  • Node.js 24 LTS（24.x，24.10 或更新）、pnpm 10.25、git
模型
  • Codex 的 ChatGPT 登录，或 OpenAI / 兼容服务的 API Key

服务端：三步装好

在服务器上依次执行。HTTPS、日常运维和常见问题见完整的部署指南。

  1. 安装 Docker 和 git

    在 Ubuntu 上可以用系统自带的软件包，也可以用 Docker 官方的安装源。

    在服务器上执行
    sudo apt update
sudo apt install -y docker.io docker-compose-v2 docker-buildx git

  2. 获取代码，切到最新的发布版本

    请用发布标签，不要直接用 main。客户端和服务端应使用同一个版本，版本不一致时客户端会提示。

    在服务器上执行
    git clone https://github.com/Im-Sue/suduo-workbench.git
cd suduo-workbench
git checkout "$(git describe --tags --abbrev=0)"   # 最新的发布版本
cd cloud

  3. 一条命令安装

    在国内用 --mirror cn 走国内镜像源构建，海外去掉它。首次构建约 3–8 分钟，就绪后脚本会打印访问地址。

    在 cloud/ 目录下执行
    sudo ./scripts/suduo-cloud.sh install --mirror cn

    脚本的提示跟随服务器的系统语言，Ubuntu 服务器默认常是英文。想看中文提示，把 SUDUO_LOCALE=zh-CN 写在 sudo 后面（写在前面不起作用）：

    在 cloud/ 目录下执行
    sudo SUDUO_LOCALE=zh-CN ./scripts/suduo-cloud.sh install --mirror cn

拿到地址以后，团队成员在客户端的「设置 → 需求服务」里填上它，注册账号就能开始用。

升级、备份与恢复

同一个脚本负责日常运维，命令都在服务器的 cloud/ 目录下执行。

升级

先 git fetch --tags 并检出要升级到的发布标签，再执行 upgrade。脚本先备份再升级，备份失败就停下来；数据库在服务启动时自动迁移。

sudo ./scripts/suduo-cloud.sh upgrade

备份

数据库和附件、房间文件一起备份，保证两边对得上。备份期间服务会暂停，时长随数据量增加；默认存到 /var/backups/suduo/<时间戳>。

sudo ./scripts/suduo-cloud.sh backup

恢复

用备份替换当前全部数据：先把当前数据备份一份，再恢复，并按当前检出的版本启动。所以回滚就是检出旧版本标签，再恢复升级前的那份备份。

sudo ./scripts/suduo-cloud.sh restore /var/backups/suduo/<时间戳>

客户端：每个人的电脑

目前还没有安装包，客户端从源码运行。macOS 用终端、Windows 用 PowerShell，命令相同。不需要另外安装 Codex：pnpm install 会装上这个版本测试过的 Codex CLI。

在自己的电脑上执行
git clone https://github.com/Im-Sue/suduo-workbench.git
cd suduo-workbench
git checkout "$(git describe --tags --abbrev=0)"   # 和服务器用同一个版本
cd client
pnpm install
pnpm start

pnpm start 会检查环境，首次运行时构建（约 1–2 分钟），在 http://127.0.0.1:8787 启动并打开浏览器。按 Ctrl+C 停止。

连上团队

  1. 登录 Codex：在 client/ 目录下执行 pnpm exec codex login，或在 SuDuo 的「设置 → 模型服务」里配置（这会改写 ~/.codex，你在终端里用的 Codex CLI 也跟着改）
  2. 在「设置 → 需求服务」里填入服务器地址，注册或登录
  3. 为项目选择代码所在的本机目录，打开一条需求，开始会话

从 npm 下载很慢或失败时（例如在国内），先执行 pnpm config set registry https://registry.npmmirror.com，再 pnpm install。

完整文档在 GitHub