注册GitHub应用

关于注册 GitHub Apps

可以通过几种不同的方式注册 GitHub App。

在你的个人帐户下。
在你拥有的组织下。
在一个已授予你管理其所有应用权限的组织下。请参阅“在组织中添加和删除GitHub应用管理器”。

注册 GitHub App

在 GitHub 上任意页的右上角，单击你的个人资料图片。
导航到你的帐户设置。
- 对于由个人帐户拥有的应用，请单击“设置”****。
- 对于组织拥有的应用：
  1. 单击“你的组织”。
  2. 在组织的右侧，单击设置。
在左边栏中，单击 “Developer settings”****。
在左侧边栏中，单击“GitHub Apps”。
单击新建 GitHub App。
在“GitHub App 名称”下，输入应用的名称。你应选择一个易懂而简短的名称。名称长度不能超过 34 个字符。应用执行操作时，应用的名称（转换为小写，且空格替换为 -，并替换特殊字符）将在用户界面中显示。例如，My APp Näme 将显示为 my-app-name。

该名称在 GitHub 中必须是唯一的。不能使用与现有 GitHub 帐户相同的名称，除非该名称是你自己的用户或组织名称。
（可选）在“描述”下，键入应用的描述。用户安装应用时会看到此描述。
在“主页 URL”下，键入应用网站的完整 URL。如果没有专用 URL，且应用代码存储在公共存储库中，则可以使用该存储库 URL。或者，可以使用拥有该应用的帐户的 URL。
（可选）在“回叫 URL”下，输入用户授权安装后要重定向到的完整 URL。

可最多输入 10 个回叫 URL。若要添加其他回叫 URL，请单击“添加回叫 URL”。

如果应用不需要代表用户执行操作（不需要生成用户访问令牌），则将忽略该字段。如果应用使用设备流而不是 Web 应用流来生成用户访问令牌，则将忽略此字段。

有关回叫 URL 的详细信息，请参阅“关于用户授权回调网址”。有关生成用户访问令牌以代表用户执行操作的详细信息，请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。
（可选）若要防止用户访问令牌过期，请取消勾选“用户授权令牌过期”。 GitHub 强烈建议选择此选项。有关刷新过期令牌和过期用户访问令牌的优势的详细信息，请参阅“刷新用户访问令牌”。如果应用不需要生成用户访问令牌，则将忽略此字段。
（可选）若要在用户安装应用时提示用户为其授权，请选择“安装时请求用户授权 (OAuth)”。如果用户为应用授权，应用可以生成用户访问令牌，以代表用户发出 API 请求并将应用活动分配给用户。有关详细信息，请参阅代表用户使用 GitHub 应用进行身份验证和为 GitHub 应用生成用户访问令牌。
（可选）如果要使用设备流生成用户访问令牌，请选择“启用设备流”。有关详细信息，请参阅“为 GitHub 应用生成用户访问令牌”。
（可选）在“设置 URL”下输入用户安装应用后要重定向到的 URL。如果安装后需要其他设置，可以使用此 URL 告知用户安装后要执行的步骤。有关详细信息，请参阅“关于设置 URL”。

如果在先前的步骤中选择了“安装时请求用户授权 (OAuth)”，你将无法在此处输入 URL。用户将转而在授权流期间重定向到回叫 URL，你可在其中描述其他设置。
（可选）如果要在用户更新安装后将其重定向到设置 URL，请选择“更新时重定向”。更新包括添加或删除安装的存储库。如果“设置 URL”为空，这将被忽略。
可选：如果你不希望应用接收 webhook 事件，请取消选择“启用”。例如，如果应用仅用于身份验证或不需要响应 webhook，请取消选择此选项。有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。
如果在上一步中选择了“启用”，则在“Webhook URL”下，输入 GitHub 应将 webhook 事件发送到的 URL。有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。
（可选）如果在上一步中选择了“Active”，则在“Webhook 密钥”下，输入一个机密令牌来保护你的 webhook。 GitHub 强烈建议设置 webhook 机密。有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。
如果输入了 webhook URL，请在“SSL 验证”下选择是否启用 SSL 验证。 GitHub 强烈建议启用 SSL 验证。
在“权限”下，选择应用所需的权限。对于每种权限，请选择下拉菜单，然后单击“只读”、“读写”或“无访问权限” 。你应选择应用所需的最小权限。有关详细信息，请参阅“为GitHub应用选择权限”。
如果在先前的步骤中选择了“活动”，表示应用应接收 webhook 事件，则请在“订阅事件”下选择希望应用接收的 webhook 事件。在上一步中选择的权限决定哪些 Webhook 事件可用。有关每个 Webhook 事件的详细信息，请参阅“Webhook 事件和有效负载”。
在“此 GitHub App 可以安装在哪里？”下，选择仅在此帐户上或任何帐户。有关安装选项的详细信息，请参阅“AUTOTITLE”。
单击创建 GitHub App。

后续步骤

        [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/quickstart)

        [AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)

        [AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)

        [AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)

        [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)

你的目标应该是遵循最佳做法。有关详细信息，请参阅“创建GitHub应用的最佳做法”。

完全生成 GitHub App 后，可以安装 GitHub App 并与其他人共享你的 GitHub App。有关详细信息，请参阅安装自己的GitHub应用和共享 GitHub 应用。

始终可以更改 GitHub App 的设置。有关详细信息，请参阅“修改GitHub应用注册”。

在本文中

关于注册 GitHub Apps

注册 GitHub App

后续步骤