我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

安装 GitHub 应用程序

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

本文内容

注:您的 GitHub 应用程序 将有权访问应用程序创建的任何仓库,即使用户只在选定的仓库中安装您的应用程序。

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

创建私有 GitHub 应用程序后,您可以将其安装在您的某个组织或用户仓库中。 更多信息请参阅“私有安装流程”。

  1. GitHub 应用程序设置页面,选择您的应用程序。
  2. 在左边栏中,单击 Install App(安装应用程序)
  3. 单击包含适当仓库的组织或用户帐户旁边的 Install(安装)
  4. 将应用程序安装在所有仓库或所选仓库中。
    应用程序安装权限
  5. 安装后,您将在所选帐户上看到应用程序的配置选项。 您可以在这里进行更改,或重复前面的步骤将应用程序安装到其他帐户上。

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

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

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

这些步骤假定您已构建 GitHub 应用程序

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

在安装过程中授权用户

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

一旦有人安装了您的应用程序,您将需要为用户获取访问令牌。 更多信息请参阅“识别站点上的用户”中的步骤 2 和 3。

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

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

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

http(s)://[hostname]/apps/<app name>/installations/new?state=AB12t

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。