logo文档
English
首页文档

使用说明

首次登录

  1. 访问你的域名
  2. 点 "使用 GitHub 登录" / "使用 Google 登录" / "使用 Microsoft 登录" 或注册账号
  3. 第一个账号是管理员（或 ADMIN_USERNAME 指定的）

OAuth 首次登录需完善资料

通过 GitHub / Google / Microsoft 首次登录创建的新账号，会先进入 完善资料 页：

  1. 设置用户名（必填，默认填第三方用户名）
  2. 设置密码（必填，之后可用"邮箱+密码"登录）
  3. 人机验证（配置了 Turnstile/reCAPTCHA 时强制）
  4. 绑定邮箱（可选，绑了才能改邮箱 / 注销）

未完善前无法进入主界面，完善后自动进入。

绑定邮箱 / 更改邮箱 + 邮箱密码登录

无论你是用 GitHub / Google / Microsoft 还是密码注册，都可以绑定邮箱并设置密码，之后就能用"邮箱 + 密码"直接登录：

  • 首次绑定（账号还没有邮箱时，如 OAuth 完善资料时跳过了）：进入 个人设置 → 邮箱，填邮箱 → 发验证码 → 填验证码 + 设置登录密码 → 绑定
  • 更改邮箱（账号已有邮箱时）：个人设置 → 邮箱 → 点 "更改邮箱"：
    1. 输入原邮箱 → 发验证码到原邮箱 → 填验证码（验证所有权）
    2. 输入新邮箱 → 发验证码 → 填验证码
    3. 通过人机验证 → 提交后更改成功
  • 邮箱板块底部还有 "点我申诉"：可提交申诉 / 反馈工单给管理员

下次登录时，在登录框直接输入邮箱 + 密码即可（登录框已支持输入邮箱或用户名）。

构建第一个应用

  1. 首页输入框输入："帮我做一个计算器"
  2. 回车，自动创建 workspace 并让 agent 构建
  3. 编辑器查看代码，右侧实时预览
  4. 继续和 agent 对话修改

核心功能

工作区（Workspace）

  • 多文件代码编辑器（Monaco）
  • 文件树：新建/删除/设为入口
  • 实时预览（iframe）
  • 自动保存（含"未保存"脏点提示、agent 修改标记）
  • 实时协作：同一工作区多人同时编辑时，内容实时同步、工具栏显示在线人数（详见实时协作）
  • 一键静态发布：顶栏 发布 把工作区打包成纯静态站 + 公开链接（详见一键静态发布）

文件历史与回滚

  • 每次修改文件都会自动记录历史版本
  • 编辑器顶栏点 历史 → 选择某个版本 → 一键恢复

AI Agent

  • 用自然语言构建/修改应用
  • 支持 markdown 输出
  • 会参考你上传的上下文文档
  • 对话记录自动保存，刷新不丢失

文件分享

  • 上传到 R2，生成带有效期链接
  • 下载走 R2 直链

蓝图（Blueprints）

  • 每个工作区可导出为 .gadget.json 归档
  • 顶部 导入蓝图 可把归档恢复为一个新工作区
  • 点复制链接会生成公开蓝图链接，他人无需登录即可预览并复制代码

收藏工作区

  • 工作区卡片右上角星标即可收藏
  • 支持按"全部 / 收藏"筛选

外部连接

  • 连接 GitHub，agent 可读取你的仓库

SSH 远程会话（持久会话）

  • 远程连接 → SSH 主机：添加/删除/测试服务器，支持密码或私钥认证；凭据 AES-256-GCM 加密存储
  • 实时监控：主机名、系统、核心数、运行时长、负载、内存/磁盘用量
  • 命令终端：运行命令并实时流式输出
  • 持久会话：点终端顶部的插头按钮新建会话，服务器会记住当前目录和环境变量（export FOO=bar 会被解析），后续每条命令都自动在相同目录/环境下执行；终端头部显示 Session active · cwd
  • 会话默认 30 分钟无操作自动过期（可用 SSH_SESSION_TTL_MINUTES 调整），关掉插头即主动关闭会话

上下文文档库

  • 上传参考文档，agent 构建时会读取
  • 支持新建 / 查看 / 编辑 / 删除
  • 文档可设为公开：提交后进入管理员审核队列，通过后出现在公共库，所有用户的 agent 都会自动参考

工作区协作者

  • 打开工作区 → 顶部工具栏「协作者」（仅所有者）→ 输入用户名添加
  • 角色：只读（查看 + 预览，编辑器锁定）或可编辑（改文件 + 用 agent）
  • 协作者会在自己的「工作区」列表看到共享的工作区
  • 被邀请/移除都会收到站内通知（可开启邮件通知）

通知

  • 侧边栏铃铛：协作者变动、文档审核结果、工单回复等
  • 「设置 → 通知偏好」可选择哪些事件额外发邮件（需配置 RESEND_API_KEY 并绑定邮箱）

搜索与索引

全站搜索（⌘K / Ctrl+K）：任意页面按 ⌘K（Mac）或 Ctrl+K（Windows）打开搜索框，输入功能名的一部分或别名即可找到对应功能——例如输入 worker 找到「Worker 和 Pages」、输入 git 找到「外部连接」、输入 kv 找到「KV 缓存加速」、输入 模板 找到「蓝图」。搜索会同时匹配页面、文档、操作以及你自己的工作区和上下文文档。

文档搜索：每篇文档顶部有一个小搜索框（Bing 风格），输入关键词即可在当前语言的文档中模糊搜索，结果带高亮和摘要。搜索按语言隔离：中文文档只搜中文文档，英文文档只搜英文文档，不会混出另一种语言的结果。

搜索引擎收录（Bing）：站点自动提供：

  • sitemap.xml —— 公开页面 + 全部文档，自动生成
  • robots.txt —— 允许公开面/文档，阻止私有路径（工作区/管理/API），并引用 sitemap
  • IndexNow —— 配置 INDEXNOW_KEY 后，站点根路径提供 /{key}.txt，每日 cron 自动向 Bing 提交公开 URL 加速收录（详见环境变量）

管理后台

管理员登录 → 左侧 Admin：

  • 统计数据
  • 站点设置（名称/标语/横幅/页脚/默认模型/agent 指令）
  • 注册开关、人机验证、品牌图标
  • AI Provider
  • Cloudflare Access 状态
  • 操作日志入口（完整日志在左侧"操作日志"）

操作日志（/admin/audit）

左侧菜单 "操作日志"（需 admin.access 权限）集中展示所有日志：

  • 登录：时间、用户、IP 地址（含失败尝试）
  • Agent 运行：工作区上的 Agent 操作
  • AI 调用：每次调用并记录 token 用量
  • 导出：右上角可把当前筛选结果导出为 CSV / JSON（带 BOM，Excel 直接打开不乱码），适合长期存档或导入其他系统

AI 用量配额

管理员在 管理后台 → 用户管理 中可为单个用户或整个分组设置 AI 每日调用上限（次数）：

  • 用户配额优先于分组配额（未单独设置时用分组配额）
  • 当天调用达到上限后，该用户继续调用 AI 会收到 429 配额超限 提示，次日 0 点自动重置
  • 分析页个人卡片显示 今日 AI 调用次数，方便自查

定时任务（/admin）

管理员可在 管理后台 创建定时任务：

  • 用 cron 表达式（如 0 */6 * * * 每 6 小时）指定执行时间
  • 任务可执行：运行 AI 指令（对指定工作区）或 HTTP 回调（POST 到指定 URL）
  • 每分钟由 Vercel Cron 触发检查一次（/api/cron/tasks，需 CRON_SECRET；到点的任务在当分钟内执行，同一分钟不会重复运行）
  • 任务历史记录每次执行结果（成功/失败 + 输出摘要），列表可随时启用/停用/删除

工单管理（/admin/tickets）

左侧菜单 "工单"（需 tickets.manage 权限）：

  • 查看所有用户提交的工单（反馈 / 申诉 / 更改邮箱 / 其他）
  • 按状态筛选（待处理 / 处理中 / 已关闭）
  • 查看详情：提交人、邮箱、IP 地址、内容
  • 修改状态 + 回复用户

用户提交工单时会过人机验证，并自动邮件通知所有管理员，邮件内含处理链接。

注销账号

在 个人设置 → 注销账号：

  • 有绑定邮箱：
    1. 填绑定邮箱 → 发送验证码
    2. 填验证码 + 人机验证 → 提交
  • 没有绑定邮箱（如纯 OAuth 账号）：
    1. 点击注销 → 跳转到你已绑定的第三方登录（微软 / 谷歌 / GitHub）再验证一次身份
    2. 验证通过返回后，完成人机验证
  • 提交后进入 4–7 天冷静期，期间可随时取消
  • 到期自动永久删除账号及所有数据，邮箱/用户名释放，可重新注册

自定义网站背景

在 Vercel 环境变量添加 NEXT_PUBLIC_BEIJIN（值为背景图 URL）并 Redeploy，全站显示背景图，每次刷新重新请求。

用户分组与权限

系统用用户分组控制功能权限，分组完全决定权限。用户移入哪个分组，就获得该组的功能。

功能权限项（新建分组时勾选）：

  • 工作区 & AI agent：创建/编辑/删除工作区
  • 文件分享/蓝图：R2 分享、蓝图导出导入
  • 上下文文档库：上传/编辑参考文档
  • 外部连接：GitHub/Google/GitLab
  • 管理后台访问（管理类）：进入管理后台
  • 用户管理（管理类）：管理用户和分组

管理类功能（admin.access、admin.users）只有被分到"超级管理员"或勾了这些权限的分组的用户才能看到。普通用户看不到管理入口。

内置分组：

  • 超级管理员：拥有全部权限
  • 普通用户：只有工作区 & AI

第一个用户自动进入超级管理员分组；ADMIN_USERNAME 指定的用户也进超级管理员分组。

用户管理（/admin/users）

有 admin.users 权限的用户可在左侧 用户管理 页面：

  • 新建用户（用户名/显示名/密码/邮箱/分组）
  • 编辑用户：改密码、改邮箱、移动分组
  • 删除用户
  • 新建分组（勾选功能权限）、编辑分组权限、删除分组

分析页（/analytics）

所有登录用户都能在左侧 分析 页面查看详细统计：

  • 个人卡片：工作区数、文件数、今日登录次数、今日 AI 调用次数、今日 Token 用量
  • 今日登录记录：你今天登录用的 IP 地址 + 时间

管理员额外看到全站今日概览：今日登录总数、活跃用户、AI 调用、Token 总量，以及今日登录 IP 分布（Top 10 条形图）。

移动端

  • 侧边栏自动收起到菜单按钮
  • 文档站适配手机
  • 推荐在手机浏览器用"添加到主屏幕"