Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档

安装 GitHub 应用程序

当你的应用公开时,任何人都可以使用 安装 URL 在其存储库中安装该应用。 当您的应用程序为私有时,只有您能将该应用程序安装在您自己的仓库中。

注意:你的 GitHub App 将有权访问应用创建的任何存储库,即使用户只在选定的存储库中安装你的应用。

在您的仓库中安装您的私有 GitHub 应用程序

创建私有 GitHub 应用程序后,您可以将其安装在您的某个组织或用户仓库中。 有关详细信息,请参阅“将 GitHub 应用程序设为公共或私有”。

  1. GitHub 应用设置页,选择你的应用。
  2. 在左侧边栏中,单击“安装应用”。
  3. 单击包含适当存储库的组织或个人帐户旁边的“安装”。
  4. 选择“所有存储库”或“仅选择存储库”。
  5. 如果选择“仅选择存储库”,请选择“选择存储库”下拉菜单,然后单击要在其中安装应用的存储库。
  6. 单击“安装” 。 安装后,您将在所选帐户上看到应用程序的配置选项。 您可以在这里进行更改,或重复前面的步骤将应用程序安装到其他帐户上。

允许用户在他们的仓库中安装您的公共应用程序

您可以通过在应用程序的主页等位置提供安装 URL,使其他人能够安装您的公共应用程序。 然后,您可以从 GitHub 的登陆页面指向您的应用程序主页。

如果要从 OAuth 应用程序迁移到 GitHub 应用程序,您可以在安装 GitHub 应用程序时使用查询参数预先选择仓库和帐户。 请参阅“将 OAuth 应用程序迁移到 GitHub 应用程序”了解详细信息。

这些步骤假定你已生成 GitHub App

  1. GitHub 应用设置页,选择要配置供他人安装的公共应用。
  2. 在“常规”选项卡的“主页 URL”下,键入应用主页的 URL,然后单击“保存更改”。
  3. GitHub 为您的应用程序提供一个登录页面,其中包含指向应用程序“Homepage URL(主页 URL)”的链接。 要访问 GitHub 上的登录页面,请从“Public link(公共链接)”复制 URL 并将其粘贴到浏览器中。
  4. 为应用创建一个包含应用安装 URL 的主页:http(s)://HOSTNAME/github-apps/<app name>/installations/new

在安装过程中授权用户

您可以通过在应用程序安装过程中完成授权过程来简化它。 为此,在 GitHub 中创建或修改应用时请选择“在安装过程中请求用户授权 (OAuth)”。 请参阅“创建 GitHub 应用程序”了解详细信息。

一旦有人安装了您的应用程序,您将需要为用户获取访问令牌。 有关详细信息,请参阅“代表用户使用 GitHub 应用进行身份验证”中的步骤 2 和 3。

在安装过程中保留应用程序状态

你可以在应用的安装 URL 中提供 state 参数,以保留应用程序页面的状态,并在用户安装、身份验证或接受 GitHub 应用的更新后将用户返回到该状态。 例如,可使用 state 参数将安装关联到用户或帐户。

要保留状态,请将其添加到安装 URL:

http(s)://HOSTNAME/github-apps/<app name>/installations/new?state=AB12t