跳到主要内容

设置 GitHub 社交登录

Logto 官方的 GitHub 社交登录连接器。

提示:

本指南假设你对 Logto 连接器 (Connectors) 有基本的了解。对于不熟悉的人,请参考 连接器 (Connectors) 指南以开始了解。

开始使用

GitHub 连接器使终端用户能够通过 GitHub OAuth 2.0 认证 (Authentication) 协议使用他们自己的 GitHub 账户登录到你的应用程序。

使用 GitHub 账户登录

访问 GitHub 网站并使用你的 GitHub 账户登录。如果你没有账户,可以注册一个新账户。

创建和配置 OAuth 应用

按照创建 OAuth 应用指南,注册一个新应用。

Application name 中为你的新 OAuth 应用命名,并填写应用的 Homepage URL。你可以将 Application description 字段留空,并将 Authorization callback URL 自定义为 ${your_logto_origin}/callback/${connector_id}connector_id 可以在 Logto 管理控制台连接器详情页面的顶部栏找到。

备注:

如果在登录时遇到错误信息“重定向 URI 必须与此应用程序注册的回调 URL 匹配。”,请尝试对齐 GitHub OAuth 应用的授权回调 URL 和 Logto 应用的重定向 URL(当然,包括协议)以解决问题。

我们建议不要勾选 Enable Device Flow 前的框,否则在移动设备上使用 GitHub 登录的用户必须在 GitHub 应用中确认初始登录操作。许多 GitHub 用户没有在手机上安装 GitHub 移动应用,这可能会阻碍登录流程。如果你希望终端用户确认他们的登录流程,请忽略我们的建议。查看 设备流 的详细信息。

管理 OAuth 应用

访问 OAuth 应用页面,你可以添加、编辑或删除现有的 OAuth 应用。 你还可以在 OAuth 应用详情页面找到 Client ID 并生成 Client secrets

配置你的连接器

clientIdclientSecret 字段中填写你从上一节提到的 OAuth 应用详情页面获得的 Client IDClient Secret

scope 是一个以空格分隔的权限 (Scopes)列表。如果未提供,权限 (Scope) 默认为 read:user

配置类型

名称类型
clientIdstring
clientSecretstring
scopestring

测试 GitHub 连接器

就是这样。GitHub 连接器现在应该可用了。别忘了在登录体验中启用社交连接器

参考

GitHub - 开发者 - 应用

GitHub - 开发者 - 应用 - 创建 OAuth 应用