Skip to main content

Enabling GitHub Connect for GitHub.com

Enable GitHub Connect to access additional features and workflows from GitHub.com on 你的 GitHub Enterprise Server 实例.

You can access additional features and workflows on 你的 GitHub Enterprise Server 实例 by enabling GitHub Connect. See "关于 GitHub Connect."

What happens when GitHub Connect is enabled?

When you enable GitHub Connect, you configure a connection between 你的 GitHub Enterprise Server 实例 and an enterprise account on GitHub Enterprise Cloud. 连接通过端口 443 或 80 使用 HTTPS,并受 TLS 保护。

Enabling GitHub Connect creates a GitHub App owned by the enterprise account on GitHub Enterprise Cloud. GitHub Enterprise Server uses the GitHub App's credentials to make requests to GitHub Enterprise Cloud.

GitHub Enterprise Server stores credentials from the GitHub App. 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 Backup Utilities.

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

Prerequisites

  • You must have an enterprise account on GitHub.com that uses GitHub Enterprise Cloud.
  • Your enterprise account on GitHub.com must be invoiced. Enterprise accounts on the free trial of GitHub Enterprise Cloud or that pay by credit card cannot be connected to 你的 GitHub Enterprise Server 实例.
  • If your 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. See "为企业中的安全设置实施策略" 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 "配置出站 Web 代理服务器."
  • If you have previously enabled GitHub Connect for an enterprise on GHE.com, you must change your configuration to allow connections to GitHub.com. See "Enabling GitHub Connect for GHE.com."

Enabling GitHub Connect

To enable GitHub Connect, you must be an enterprise owner on both GitHub Enterprise Server and GitHub Enterprise Cloud.

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

  2. 在 GitHub Enterprise Server 的右上角,单击你的个人资料照片,然后单击“企业设置”****。

    单击 GitHub Enterprise Server 上的个人资料照片时显示的下拉菜单的屏幕截图。 “企业设置”选项以深橙色边框突出显示。

  3. 在企业帐户边栏中,单击 GitHub Connect。

  4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "GitHub 附加产品和功能条款."

  5. To the right of the enterprise account you'd like to connect, click Connect.