登录鉴权

接入 Google 和 GitHub 登录

完成后,登录页和注册页会显示 Google 或 GitHub 按钮,用户可以用已有账号直接登录。

Google 和 GitHub 登录在后台中分别开启。每个提供方都需要在对方平台登记一个 OAuth 应用,修改在下一次登录时生效,无需重启。

准备工作

  • 一个有公网地址的部署,并已在 认证配置 中设置 基础 URL,见 配置邮箱密码登录。
  • 拥有 config.read 和 config.write 的管理员账号。
  • 可以创建 OAuth 应用的 Google Cloud 项目或 GitHub 账号。

登记 OAuth 应用

厂商适用场景
Google使用 Google Web OAuth 客户端登录
GitHub通过 GitHub OAuth 应用登录

开启提供方

填入凭证

在 Google 登录 或 GitHub 登录 面板中,填入 OAuth 应用页面上的 Client ID 和 Client Secret。凭证保存后不会再显示。留空即保留已保存的值。

调整开关

  • 已启用:在登录页和注册页显示该提供方的按钮。
  • 允许新用户注册:关闭后,该提供方只允许已有账号的用户登录。

保存

点击该面板中的 保存。登录渠道 面板会显示哪些登录方式已启用。

缺少凭证的按钮

按钮已启用但缺少 Client ID 或 Client Secret 时,点击后只显示需要先配置凭证的提示,不会跳转。

服务商

Prop

Type

没有凭据的服务商会解析成禁用的服务商,登录页不提供它。

验证

在浏览器无痕窗口中打开 /auth/sign-in,点击 使用 Google 登录 或 使用 GitHub 登录。在提供方页面授权后会进入 /app/profile。pnpm validate:auth 也会检查未配置状态和 认证配置 页的接入情况。

常见问题

提供方拒绝跳转

在 Google 或 GitHub 登记的回调地址与 回调 URL 面板中的不一致。重新复制一次,协议和域名都要一致。

用户被带到 /auth/error

跳转之后 OAuth 交换失败。确认 Client Secret 与 Client ID 属于同一个应用。在提供方重新生成过 secret 的,需要重新填入。

新用户无法用提供方登录

该提供方的 允许新用户注册 已关闭,只有已有账号能使用。打开开关并点击 保存。

参考

下一步