跳到内容
Localtonet Localtonet 控制台

使用 GitHub 单点登录

需要余额 HTTP 隧道

获取本页帮助
本页内容 4 个章节
  1. 开始之前
  2. 步骤
  3. 在 GitHub 上注册 OAuth 应用
  4. 在 Localtonet 中添加提供商
  5. 为隧道开启它
  6. 测试
  7. 故障排查
  8. 相关页面

让访问者在打开 HTTP 隧道之前,先使用自己的 GitHub 账户登录。你需要在 GitHub 上注册一个 OAuth 应用,把它作为提供商添加到 Localtonet,然后为隧道开启它。

开始之前 #

  • 一条 HTTP 隧道,以及你账户中的余额。参见单点登录概览。
  • 一个 GitHub 账户。如果要为某个组织注册该应用,你需要有该组织设置的访问权限。

步骤 #

  1. 在 GitHub 上注册 OAuth 应用 #

    GitHub 自己的指南是 Creating an OAuth app。简要步骤如下:

    1. 在 GitHub 上,打开头像下的菜单,依次选择 Settings、Developer settings、OAuth apps。
    2. 选择 New OAuth App。如果你还没有任何应用,该按钮显示为 Register a new application。
    3. 按下面的值填写表单,然后选择 Register application。
    4. 在新应用的页面上,复制 Client ID,然后选择 Generate a new client secret 并立即复制密钥。
    GitHub 字段值
    Application name一个访问者能认出的名称。GitHub 在请求他们授权时会显示它。
    Homepage URL一个介绍该应用的网址,例如你的网站。
    Authorization callback URLhttp://auth.localtonet.com/auth/callback
    Enable Device Flow保持关闭。

    你不需要在 GitHub 上选择权限范围。登录请求会指明它们:read:user 和 user:email。访问者首次登录时,GitHub 会请他们批准这些范围。

  2. 在 Localtonet 中添加提供商 #

    打开我的隧道 › HTTP,选择页面顶部的 SSO。在 SSO 提供商对话框中,选择添加提供商。

    字段值
    提供商名称任意名称,例如 GitHub。你会在隧道设置中看到它。
    提供商类型GitHub。更改已保存提供商的类型会清空客户端 ID,因此请重新输入客户端 ID 和客户端密钥。
    已启用开
    客户端 ID来自 GitHub 的客户端 ID。
    客户端密钥来自 GitHub 的客户端密钥。保存后不会再显示。

    在端点与回调下,GitHub 的标准地址会自动填入。请保持原样:

    字段自动填入的值
    授权端点https://github.com/login/oauth/authorize
    令牌端点https://github.com/login/oauth/access_token
    用户信息端点https://api.github.com/user
    回调路径/auth/callback/github

    可选择填写邮箱访问规则,然后选择保存提供商。

  3. 为隧道开启它 #

    在你的隧道下,选择隧道上的设置,然后选择SSO 提供商旁边的管理。在单点登录对话框中,开启要求登录和你的 GitHub 提供商的开关。选择保存。

    任何人都可以创建 GitHub 账户。如果没有规则,每个知道地址的 GitHub 用户都可以打开该隧道。请填写隧道上的谁可以登录,或提供商上的允许的邮箱域名。这些列表在概览中有说明。

  4. 测试 #

    在无痕浏览器窗口中打开隧道 URL。Localtonet 会显示 Sign in to continue,并带有你的提供商的按钮。首次使用时,GitHub 会请你授权该应用。之后你会被送回隧道,你的服务随即加载。

故障排查 #

GitHub 报告重定向 URI 不匹配

GitHub 的错误是 redirect_uri_mismatch:"The redirect_uri MUST match the registered callback URL for this application." OAuth 应用的所有回调 URL 都与发送的地址不匹配。请在 GitHub 上把 Authorization callback URL 设为准确的 http://auth.localtonet.com/auth/callback。

访问者的地址在列表中,却被拒绝

当 GitHub 用户没有在个人资料中设置公开邮箱时,默认的用户信息端点 https://api.github.com/user 可能不会返回邮箱地址。请让访问者检查其 GitHub 个人资料中设为公开邮箱的是哪个地址,并与你的列表比对。

GitHub 登录成功后出现“403 - Access Denied”

Localtonet 的某条规则拒绝了该账户。请检查提供商上的邮箱访问规则和隧道上的谁可以登录。更正规则后,请等待一分钟再重新加载。

登录在 GitHub 授权页面之前或之后失败

请对照 OAuth 应用,检查 Localtonet 中保存的客户端 ID和客户端密钥。重新粘贴客户端 ID,在 GitHub 上生成新的客户端密钥,把它粘贴到提供商中,然后选择保存提供商。

登录页面上没有 GitHub 按钮

该提供商没有为这条隧道开启,或者被设为未启用。请检查这两处。

支持