Enabling GitHub Connect for GitHub.com

You can access additional features and workflows on your GitHub Enterprise Server instance by enabling GitHub Connect. See About GitHub Connect.

What happens when GitHub Connect is enabled?

When you enable GitHub Connect, you configure a connection between your GitHub Enterprise Server instance and an enterprise account on GitHub Enterprise Cloud. The connection uses HTTPS over ports 443 or 80 and is secured by 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 your GitHub Enterprise Server instance.
If your enterprise account on GitHub.com uses IP allow lists, you must add the IP address or network for your GitHub Enterprise Server instance to your IP allow list. See 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.
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.