Skip to content

getting-started.md

Latest commit

 

History

History
310 lines (220 loc) · 9.65 KB

getting-started.md

File metadata and controls

310 lines (220 loc) · 9.65 KB
Raw

从零开始部署 AutoTeam

本文档带你从一台全新的 VPS 或本地机器开始，完成 AutoTeam 的安装、配置、管理员登录、首次补号与日常使用。

前置条件

在开始之前，你需要准备好以下服务：

服务 说明 获取方式
ChatGPT Team 订阅 管理员主号，需要有 Team 订阅 chatgpt.com
CloudMail / Cloudflare Temp Email 可配一个或多个的临时邮箱服务，用于自动注册与收验证码 自建 cloud-mail / cloudflare_temp_email
CLIProxyAPI / Sub2API 可选的认证同步目标，可启用一个或同时启用 自建 CLIProxyAPI / Sub2API
VPS / 本地机器 推荐 Ubuntu 22.04+；也支持 Windows / macOS 任意云服务商 / 本地电脑
域名 用于邮箱服务与 Verified Domains 任意域名注册商

建议使用住宅 IP 或干净的 VPS IP，避免被 OpenAI / Cloudflare 标记。

准备工作

1. 搭建邮箱服务（CloudMail / Cloudflare Temp Email）

至少准备一个即可；如果你有多个邮箱后缀或多个后端实例，也可以同时配置多个。

方案 A：CloudMail

参考 CloudMail 官方文档完成搭建：https://doc.skymail.ink/guide/dashboard

搭建完成后你会得到：

  • CloudMail API 地址（如 https://your-domain.com/api）
  • 管理员邮箱和密码
  • 邮箱域名（如 @your-domain.com）

方案 B：Cloudflare Temp Email

项目地址：https://github.com/dreamhunter2333/cloudflare_temp_email

搭建完成后你通常会得到：

  • 后端 API 地址（如 https://temp-email-api.example.com 或 https://xxxxx.workers.dev）
  • 管理员密码
  • 默认邮箱域名（如 email.example.com）

注意：AutoTeam 里 CF_TEMP_EMAIL_BASE_URL 要填写 后端 API 根地址，不是前端 pages.dev 管理页面地址。

2. 设置 OpenAI Verified Domains

由于重复邀请有概率触发 "unable to invite user due to an error." 错误（参考），需要设置域名验证让账号自动加入 Team：

  1. 打开 ChatGPT → Settings → Account
  2. 找到 Verified Domains，点击 Verify new domain
  3. 输入你的域名（如 your-domain.com）
  4. 在 Cloudflare（或你的 DNS 服务商）添加 OpenAI 要求的 DNS 记录
  5. 回到 ChatGPT 点击 Check，验证通过后状态变为 verified
  6. 进入 Workspace → Identity & Access，打开 Automatic account creation

这样使用该域名邮箱注册的 ChatGPT 账号会自动加入 Team workspace，不需要手动邀请。

3. 搭建远端同步目标（CLIProxyAPI / Sub2API）

可选，但推荐至少准备一个；也可以两个都启用。

方案 A：CLIProxyAPI

参考 CPA 项目文档完成搭建：https://github.com/router-for-me/CLIProxyAPI

搭建完成后你会得到：

  • CPA 地址（如 http://127.0.0.1:8317）
  • 管理密钥（secret-key）

方案 B：Sub2API

项目地址：https://github.com/Wei-Shaw/sub2api

搭建完成后你会得到：

  • Sub2API 地址（如 http://127.0.0.1:8080）
  • 管理员邮箱
  • 管理员密码
  • 可选分组名 / 分组 ID（如果你希望同步后的账号自动加入分组）

第一步：安装

方式一：直接部署

# 克隆项目
git clone https://github.com/cnitlrt/AutoTeam.git
cd AutoTeam

# Linux 一键安装（uv、依赖、Playwright、pre-commit）
bash setup.sh

Windows / macOS 可直接执行：

uv sync
uv run playwright install chromium

Windows / macOS 不需要 xvfb。Linux 无图形环境时项目会自动处理虚拟显示。

方式二：Docker 部署

git clone https://github.com/cnitlrt/AutoTeam.git
cd AutoTeam
mkdir -p data
docker compose up -d

第二步：配置

直接部署

启动任何命令时会自动进入配置向导：

uv run autoteam api

按提示依次填入（首次启动只强制要求 API Key，其余也可稍后在 Web 配置面板填写）：

=== AutoTeam 首次配置 ===

  API 鉴权密钥 [回车自动生成]:

如果你直接在 .env / 配置面板里填写运行项，常见组合例如：

# 兼容旧版的单邮箱服务写法
MAIL_PROVIDER=cloudmail
CLOUDMAIL_BASE_URL=https://your-cloudmail.com/api
CLOUDMAIL_EMAIL=admin@your-domain.com
CLOUDMAIL_PASSWORD=your_password
CLOUDMAIL_DOMAIN=@your-domain.com

# 或
MAIL_PROVIDER=cloudflare_temp_email
CF_TEMP_EMAIL_BASE_URL=https://temp-email-api.example.com
CF_TEMP_EMAIL_ADMIN_PASSWORD=your_admin_password
CF_TEMP_EMAIL_DOMAIN=email.example.com

如果你需要同时维护多个邮箱服务，更推荐直接在 Web 配置面板里“添加/删除邮箱服务”。保存后会自动写入：

MAIL_SERVICES_JSON=[{"id":"cm-1","type":"cloudmail","name":"CloudMail #1","base_url":"https://mail-a.example.com/api","email":"admin@a.example.com","password":"secret","domain":"a.example.com"},{"id":"cf-1","type":"cloudflare_temp_email","name":"CF Temp","base_url":"https://temp.example.com","admin_password":"secret2","domain":"mail.example.com"}]
MAIL_SERVICE_DEFAULT=cf-1

# 远端同步（可启用一个或两个）
SYNC_TARGET_CPA=true
CPA_URL=http://127.0.0.1:8317
CPA_KEY=your_cpa_key

SYNC_TARGET_SUB2API=true
SUB2API_URL=http://127.0.0.1:8080
SUB2API_EMAIL=admin@example.com
SUB2API_PASSWORD=your_sub2api_password
SUB2API_GROUP=Team Pool
SUB2API_PROXY=Residential Pool
SUB2API_CONCURRENCY=10
SUB2API_PRIORITY=1
SUB2API_RATE_MULTIPLIER=1
SUB2API_AUTO_PAUSE_ON_EXPIRED=true
SUB2API_MODEL_WHITELIST=gpt-5.4,gpt-5.4-mini,gpt-5.3-codex
SUB2API_OPENAI_WS_MODE=off
SUB2API_OPENAI_PASSTHROUGH=false
SUB2API_OVERWRITE_ACCOUNT_SETTINGS=false

配置保存时会自动验证当前邮箱服务，以及已启用的 CPA / Sub2API 连通性，失败会提示具体原因。

Docker 部署

方式一：编辑配置文件

cp .env.example data/.env
nano data/.env   # 填入实际配置
docker compose restart

方式二：Web 页面配置

直接打开 http://your-server:8787，会显示配置向导页面，在浏览器中填写。

如果你需要让浏览器流量走宿主机 SOCKS5 代理，请先确认容器内可以解析并访问宿主机代理地址（例如 host.docker.internal，或你自己提供的宿主机网关别名）。

然后在 data/.env 中加入：

PLAYWRIGHT_PROXY_URL=socks5://host.docker.internal:1080
PLAYWRIGHT_PROXY_BYPASS=localhost,127.0.0.1

如果代理需要认证，建议改用 HTTP 代理：

PLAYWRIGHT_PROXY_URL=http://username:password@host.docker.internal:1080

注意：Playwright / Chromium 不支持带认证的 socks5，因此不要写成 socks5://username:password@host:port。

第三步：管理员登录

配置完成后，需要先用 ChatGPT Team 管理员账号登录。

通过 Web 面板

  1. 打开 http://your-server:8787
  2. 输入 API Key 进入面板
  3. 进入「配置面板 → 管理员 / 主号」
  4. 输入管理员邮箱，点击「开始登录」
  5. 按提示输入密码或邮箱验证码
  6. 选择 Team workspace（如 Idapro）
  7. 登录成功后会自动保存到 state.json

通过命令行

uv run autoteam admin-login --email your-admin@example.com

第四步：首次轮转

uv run autoteam rotate 5

或在 Web 面板「账号池操作」页点击「智能轮转」。

首次运行会：

  1. 同步 Team 实际成员到本地
  2. 检查所有 active 账号额度
  3. 移出额度低于阈值的账号
  4. 优先复用 standby 中额度已恢复的旧号
  5. 不够时自动创建新账号
  6. 同步 active 认证文件到已启用远端（CPA / Sub2API）

注意： rotate 5 / fill 5 中的 5 指的是 Team 总人数目标，不是“本地管理账号数量”。 如果 Team 中已经有 owner / 外部成员，它们也会计入总数。

如果你把总 seat 数设为 2，系统为了尽量做到无感切换，可能会先加新账号再移出旧账号，短时间内多占一个 seat，因此下个月账单可能略高。 如果不希望这样，建议将主号的 seat type 改成 codex，并保持总 seat 数仍为 2。

第五步：日常使用

方式一：API 模式（推荐）

uv run autoteam api

API 模式下：

  • Web 面板集中管理日常操作
  • 后台自动巡检（默认每 5 分钟）
  • 可在「同步中心」中做对账与双向同步
  • 可在「OAuth 登录」页手动导入账号

方式二：手动执行

uv run autoteam status      # 查看状态
uv run autoteam check       # 检查额度
uv run autoteam rotate 5    # 智能轮转
uv run autoteam sync        # 同步到已启用远端
uv run autoteam pull-cpa    # 从 CPA 拉回本地

常见流程

添加更多账号

uv run autoteam rotate 8   # 补满到 8 个总席位
# 或
uv run autoteam add        # 自动注册并添加一个
# 或
uv run autoteam manual-add # 手动 OAuth 导入一个账号

清理多余账号

uv run autoteam cleanup 5  # 保留 5 个总席位

从 CPA 恢复认证文件到本地

uv run autoteam pull-cpa

或在 Web 面板「同步中心」页点击「拉取 CPA」。

该操作会：

  • 从 CPA 下载 codex-*.json
  • 清理同账号重复文件
  • 按本地命名规范重写到 auths/
  • 将新导入账号补进 accounts.json（默认标记为 standby）

下一步