Skip to main content

将 GitHub 应用程序设为公共或私有

注册 GitHub App 时,你可以将其设为公共应用,以便其他 GitHub 用户或组织都可以安装该应用,或将其设为私有应用,以便你只能在拥有该应用的帐户上进行安装。

关于 GitHub Apps 的可见性

可以将 GitHub App 注册设为公共或私有应用。 如果将 GitHub App 注册设为公共应用,并且 GitHub App 注册由 Enterprise Managed User 帐户拥有,则企业拥有的帐户都可以安装该应用,但无法在企业外部的帐户上进行安装。 如果 GitHub App 注册由不是 Enterprise Managed User 的帐户拥有,并且该应用设为公共应用,则 GitHub.com 或 GitHub Enterprise Cloud 上的任何用户都可以安装该应用。 如果将 GitHub App 注册设为私有应用,则只能在拥有该应用的帐户上进行安装。

可以在个人帐户或组织下注册 GitHub App,并使其可供其他组织安装。 你不需要企业计划或组织帐户即可使 GitHub App 可供组织使用,即使组织在 GitHub Enterprise Cloud 上由企业拥有也是如此。

如果要使你的应用可用于GitHub Enterprise Server 实例,则需要采取其他步骤。 有关详细信息,请参阅“使 GitHub Apps 可用于 GitHub Enterprise Server”。

如果GitHub Enterprise Server 用户能够使用你的工具非常重要,请考虑使用 GitHub Actions 而不是 GitHub App。 公共操作在具有 GitHub Connect 的 GitHub Enterprise Server 实例上可用。 有关详细信息,请参阅 GitHub Enterprise Server 文档中的“使用 GitHub Connect 启用对 GitHub.com 操作的自动访问”和“About GitHub Actions for enterprises”"。

有关更改 GitHub App 注册的可见性的信息,请参阅“修改 GitHub 应用注册”。

公共安装流程

公共 GitHub Apps 有一个包含“安装”按钮的登录页面,以便其他人可以在自己的存储库中安装该应用。 如果你的 GitHub App 公开给 GitHub.com 上的所有用户,你也可以选择将其发布到 GitHub Marketplace。 有关详细信息,请参阅“关于面向应用的 GitHub Marketplace”。

私有安装流程

私有 GitHub Apps 应用只能安装在应用所有者的用户或组织帐户上。 有关应用的有限信息将显示在应用的登录页面上,但“安装”按钮仅对拥有应用的组织的组织所有者和应用管理员可用,或者如果 GitHub App 归个人帐户所有,则该按钮仅对个人帐户可用。