Skip to main content

此版本的 GitHub Enterprise 将停止服务 2023-01-18. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

创建 GitHub 应用程序

您可以在您的个人帐户下或在您有管理权限的任何组织下创建和注册 GitHub 应用程序。

  1. 导航到您的帐户设置。

    • 对于个人帐户拥有的 GitHub App,在任何页面的右上角,单击你的个人资料照片,然后单击“设置”。 用户栏中的 Settings 图标
    • 对于组织拥有的 GitHub App,在任何页面的右上角,单击你的个人资料照片,然后单击你的组织。 然后,在组织右侧,单击“设置”。 个人资料菜单中的你的组织 设置按钮
  2. In the left sidebar, click Developer settings. Developer settings

  3. 在左侧边栏中,单击“GitHub 应用”。 GitHub 应用部分

  4. 单击“新建 GitHub 应用”。 用于创建新 GitHub 应用的按钮

  5. 在“GitHub App name(GitHub 应用程序名称)”中,输入应用程序的名称。 GitHub 应用的名称字段

    给应用程序一个清晰简洁的名称。 应用程序不能与现有 GitHub 帐户同名,除非它是您自己的用户或组织的名称。 当您的集成执行操作时,应用程序名称的缓存版本将显示在用户界面上。

  6. (可选)在“Description(说明)”中,输入用户将看到的应用程序说明。 GitHub 应用的说明字段

  7. 在“Homepage URL(主页 URL)”中,输入应用程序网站的完整 URL。 GitHub 应用的主页 URL 字段

  8. 在“Callback URL(回调 URL)”中,键入用户授权安装后要重定向到的完整 URL。 如果应用程序需要识别和授权用户到服务器的请求,则使用此 URL。

    可以使用“添加回调 URL”来提供额外的回调 URL,最多不超过 10 个。

    “添加回调 URL”按钮和用于回调 URL 的字段

  9. 默认情况下,为了提高应用程序的安全性,应用程序将使用过期用户授权令牌。 要选择不使用过期用户令牌,您必须取消选中“Expire user authorization tokens(过期用户授权令牌)”。 若要详细了解如何设置刷新令牌流以及用户令牌过期的好处,请参阅“刷新用户到服务器访问令牌”。 在 GitHub 应用安装过程中选择加入过期用户令牌的选项

  10. 如果应用授权用户使用 OAuth 流,则你可以选择“在安装过程中请求用户授权(OAuth)”,以允许用户在安装应用时对其进行授权,从而省去一个步骤。 如果您选择此选项,则“设置 URL”将不可用,用户在安装应用程序后将被重定向到您的“用户授权回调 URL”。 有关详细信息,请参阅“在安装期间授权用户”。 在安装过程中请求用户授权

  11. 如果安装后需要附加设置,请添加一个“设置 URL”以便在用户安装应用程序后重定向他们。 GitHub 应用的安装 URL 字段

    注意:如果在上一步选择了“在安装过程中请求用户授权(OAuth)”,此字段将不可用,用户在安装应用后将被重定向到“用户授权回调 URL” 。

  12. 在“Webhook URL(Web 挂钩 URL)”中,输入事件将 POST 到的 URL。 每个应用程序都会收到自己的 web 挂钩(每当应用程序被安装或修改时都会通知您)以及应用程序订阅的任何其他事件。 GitHub 应用的 Webhook URL 字段

  13. (可选)在“Webhook Secret(Web 挂钩密钥)”中,输入用于保护 web 挂钩的可选密钥令牌。 添加 Webhook 机密令牌的字段

    注意:强烈建议设置机密令牌。 有关详细信息,请参阅“保护 Webhook”。

  14. 在“Permissions(权限)”中,选择应用程序将请求的权限。 对于每种权限类型,请使用下拉菜单,然后单击“只读”、“读写”或“无访问权限” 。 GitHub 应用的各种权限

  15. 在“Subscribe to events(订阅事件)”中,选择您想要应用程序接收的事件。

  16. 若要选择应用的安装位置,请选择“仅在此帐户上”或“任何帐户” 。 有关安装选项的详细信息,请参阅“将 GitHub 应用设为公开或专用”。 GitHub 应用的安装选项

  17. 单击“创建 GitHub 应用”。 创建 GitHub 应用的按钮