After you enable GitHub Connect, you can share specific features and workflows between your GitHub Enterprise Server instance and a GitHub.com organization on GitHub Enterprise Cloud.

In this guide

About GitHub Connect

To enable GitHub Connect, you must configure the connection in both your GitHub Enterprise Server instance and in your GitHub Enterprise Cloud organization. To configure the connection, you must be a site administrator for your GitHub Enterprise Server instance and be an owner for the GitHub Enterprise Cloud organization.

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

After enabling GitHub Connect, you will be able to search across your GitHub Enterprise Server instance and GitHub.com. For more information, see "Enabling unified search between GitHub Enterprise Server and GitHub.com."

You will also have the option to request access to enable unified contributions between your GitHub Enterprise Server instance and GitHub.com. For more information, see "Enabling unified contributions between GitHub Enterprise Server and GitHub.com."

When you connect your GitHub Enterprise Server instance to your GitHub.com organization, a record on GitHub.com stores information about the connection:

  • The public key portion of your GitHub Enterprise Server license
  • A hash of your GitHub Enterprise Server license
  • The customer name on your GitHub Enterprise Server license
  • The hostname of your GitHub Enterprise Server instance
  • The version of your GitHub Enterprise Server instance
  • The organization on GitHub.com that's connected to your GitHub Enterprise Server instance
  • The authentication token that's used by your GitHub Enterprise Server instance to make requests to GitHub.com

Enabling GitHub Connect also creates a GitHub App owned by your GitHub.com organization. GitHub Enterprise Server uses the GitHub App's credentials to make requests to GitHub.com.

GitHub Enterprise Server stores credentials from the GitHub App. These credentials will be replicated to any high availability or clustering environments, 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

Enabling GitHub Connect will not allow GitHub.com users to make changes to GitHub Enterprise Server.

Enabling GitHub Connect

  1. Sign in to your GitHub Enterprise Server instance and GitHub.com.
  2. In the upper-right corner of any page, click . Rocketship icon for accessing site admin settings

  3. In the left sidebar, click Business. Business tab in the Site admin settings

  4. Under your business account's name, click Settings. Settings tab on the business account profile page

  5. In the left sidebar, click GitHub Connect. GitHub Connect tab in the business account settings sidebar

  6. Under "GitHub.com connection", click Connect to GitHub.com. Connect to GitHub.com button

  7. Read the addendum to the GitHub Enterprise Server License Agreement, then click I agree, connect to GitHub.com.

    GitHub Connect Addendum and I agree, connect to GitHub.com button

  8. After you're redirected to GitHub.com, next to the organization you'd like to connect to, click Connect. Connect button next to organization on GitHub.com

  9. Review the permissions requested by the connection GitHub App, then click Install. GitHub App permissions page and Install button