From 0034fdb6210f4b613b91eeca91b7a9bd25a34f91 Mon Sep 17 00:00:00 2001 From: gdz66601 Date: Sun, 27 Sep 2026 12:01:52 +0800 Subject: [PATCH] docs(deploy): document GH-prefixed OAuth settings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 补全 README 快速部署变量表与本地环境示例，明确旧 GITHUB_* 名称的迁移方式。 EdgeSSH-Auto-Update: true --- .env.example | 3 ++- README.md | 20 ++++++++++++++------ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 952e94d..266f0cb 100644 --- a/.env.example +++ b/.env.example @@ -6,8 +6,9 @@ APP_ORIGIN=https://your-worker.example.workers.dev # cloudflare 模式需要以下两项；github 模式不需要。 ACCESS_TEAM_DOMAIN=your-team.cloudflareaccess.com ACCESS_AUD=your-access-application-audience -# github 模式填写 OAuth App 和管理员数字 ID；本地 D1 的 workspace_state 也要选择 github。 +# github 模式填写 OAuth App；首次部署可用管理员用户名，已有 workspace_state 时沿用或填写数字 ID。 # GH_CLIENT_ID= # GH_CLIENT_SECRET= +# GH_ADMIN= # GH_ADMIN_ID= # ENCRYPTION_KEY 必须为 32 字节安全随机数的 Base64；本文件只用于本地开发，生产值在 Cloudflare Worker 控制台中保存为 Secret。 diff --git a/README.md b/README.md index 69c0c33..56135db 100644 --- a/README.md +++ b/README.md @@ -420,25 +420,33 @@ Worker 本身就是真正的 SSH Client,建立连接时必然要处理 SSH 凭 ### 02 · 选择认证方式 -二选一: +GitHub OAuth: ```text -GitHub OAuth +AUTH_PROVIDER=github # Variable +GH_CLIENT_ID= # Variable +GH_CLIENT_SECRET= # Secret +GH_ADMIN= # Variable ``` -或者: +或者 Cloudflare Access: ```text -Cloudflare Access +AUTH_PROVIDER=cloudflare # Variable,默认值 +ADMIN_EMAIL=<管理员邮箱> # Variable ``` +从旧版升级时,请将 `GITHUB_CLIENT_ID`、`GITHUB_CLIENT_SECRET`、`GITHUB_ADMIN`、`GITHUB_ADMIN_ID` +分别迁移为 `GH_CLIENT_ID`、`GH_CLIENT_SECRET`、`GH_ADMIN`、`GH_ADMIN_ID`。GitHub 保留 `GITHUB_` +前缀,旧名称无法作为 Actions Variable 或 Secret 使用。 + ### 03 · 添加 Cloudflare Token -在 GitHub Actions Secrets 里,加入你的 Cloudflare API Token。 +无论选择哪种认证方式,都要在 GitHub Actions Secrets 里加入 `CLOUDFLARE_API_TOKEN`。 ### 04 · Run workflow -运行 Deploy Workflow。 +运行 `Deploy` Workflow。 剩下的交给 EdgeSSH 自动完成: