docs(deploy): document GH-prefixed OAuth settings

补全 README 快速部署变量表与本地环境示例,明确旧 GITHUB_* 名称的迁移方式。

EdgeSSH-Auto-Update: true
This commit is contained in:
gdz66601 committed 2026-09-27 12:01:52 +08:00
1 parent 0b471e452f
commit 0034fdb621
2 files changed
+16 -7

No files matched your search

+2 -1
View File
@@ -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。
+14 -6
View File
@@ -420,25 +420,33 @@ Worker 本身就是真正的 SSH Client,建立连接时必然要处理 SSH 凭
### 02 · 选择认证方式
二选一:
GitHub OAuth:
```text
GitHub OAuth
AUTH_PROVIDER=github # Variable
GH_CLIENT_ID=<Client ID> # Variable
GH_CLIENT_SECRET=<Secret> # Secret
GH_ADMIN=<GitHub 用户名> # 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 自动完成: