Skip to main content

Managing GitHub Connect

You can enable GitHub Connect to access additional features and workflows for 您的 GitHub Enterprise Server 实例.

About GitHub Connect

You can access additional features and workflows on 您的 GitHub Enterprise Server 实例 by enabling GitHub Connect. For more information, see "About GitHub Connect."

When you enable GitHub Connect, you configure a connection between 您的 GitHub Enterprise Server 实例 and an organization or enterprise account on GitHub Enterprise Cloud. Enabling GitHub Connect creates a GitHub 应用程序 owned by the organization or enterprise account on GitHub Enterprise Cloud. GitHub Enterprise Server uses the GitHub 应用程序's credentials to make requests to GitHub Enterprise Cloud.

GitHub Enterprise Server stores credentials from the GitHub 应用程序. The following credentials will be replicated to all nodes in a high availability or cluster environment, and stored in any backups, including snapshots created by GitHub Enterprise Server 备份实用程序.

  • An authentication token, which is valid for one hour
  • A private key, which is used to generate a new authentication token

Prerequisites

To use GitHub Connect, you must have an organization or enterprise account on GitHub.com that uses GitHub Enterprise Cloud. You may already have GitHub Enterprise Cloud included in your plan. 有关如何免费试用 GitHub Enterprise Cloud 的详细信息,请参阅“设置 GitHub Enterprise Cloud 试用版”。

If your organization or enterprise account on GitHub.com uses IP allow lists, you must add the IP address or network for 您的 GitHub Enterprise Server 实例 to your IP allow list on GitHub.com. For more information, see "Managing allowed IP addresses for your organization" and "Enforcing policies for security settings in your enterprise" in the GitHub Enterprise Cloud documentation.

To configure a connection, your proxy configuration must allow connectivity to github.com, api.github.com, and uploads.github.com. For more information, see "Configuring an outbound web proxy server."

Enabling GitHub Connect

Enterprise owners who are also owners of an organization or enterprise account that uses GitHub Enterprise Cloud can enable GitHub Connect.

If you're connecting 您的 GitHub Enterprise Server 实例 to an organization on GitHub Enterprise Cloud that is not owned by an enterprise account, you must sign into GitHub.com as an organization owner.

If you're connecting 您的 GitHub Enterprise Server 实例 to an organization on GitHub Enterprise Cloud that is owned by an enterprise account or to an enterprise account itself, you must sign into GitHub.com as an enterprise owner.

  1. Sign in to 您的 GitHub Enterprise Server 实例 and GitHub.com.

  2. 在 GitHub Enterprise Server 的右上角,单击您的个人资料照片,然后单击 Enterprise settings(Enterprise 设置)GitHub Enterprise Server 上个人资料照片下拉菜单中的"Enterprise settings(企业设置)"

  3. 在企业帐户边栏中,单击 GitHub Connect企业帐户边栏中的 GitHub Connect 选项卡

  4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "GitHub Terms for Additional Products and Features."

    Enable GitHub Connect button

  5. Next to the enterprise account or organization you'd like to connect, click Connect. Connect button next to an enterprise account or business

Disabling GitHub Connect

Enterprise owners can disable GitHub Connect.

When you disconnect from GitHub Enterprise Cloud, the GitHub Connect GitHub 应用程序 is deleted from your enterprise account or organization and credentials stored on 您的 GitHub Enterprise Server 实例 are deleted.

  1. 在 GitHub Enterprise Server 的右上角,单击您的个人资料照片,然后单击 Enterprise settings(Enterprise 设置)GitHub Enterprise Server 上个人资料照片下拉菜单中的"Enterprise settings(企业设置)"

  2. 在企业帐户边栏中,单击 GitHub Connect企业帐户边栏中的 GitHub Connect 选项卡

  3. Next to the enterprise account or organization you'd like to disconnect, click Disable GitHub Connect.

    Disable GitHub Connect button next to an enterprise account or organization name

  4. Read the information about disconnecting and click Disable GitHub Connect. Modal with warning information about disconnecting and confirmation button