Note: GitHub Connect for GitHub AE is currently in beta and subject to change.
About GitHub Connect
You can access additional features and workflows on your enterprise by enabling GitHub Connect. For more information, see "About GitHub Connect."
When you enable GitHub Connect, you configure a connection between your enterprise and an organization or 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 organization or enterprise account on GitHub Enterprise Cloud. GitHub AE uses the GitHub App's credentials to make requests to GitHub Enterprise Cloud.
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. For more information about how you can try GitHub Enterprise Cloud for free, see "Setting up a trial of GitHub Enterprise Cloud."
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 your enterprise 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 your enterprise 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.
-
Sign in to your enterprise and GitHub.com.
-
In the top-right corner of GitHub AE, click your profile photo, then click Enterprise settings.
-
In the enterprise account sidebar, click GitHub Connect.
-
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."
-
Next to the enterprise account or organization you'd like to connect, click Connect.
Disabling GitHub Connect
Enterprise owners can disable GitHub Connect.
When you disconnect from GitHub Enterprise Cloud, the GitHub Connect GitHub App is deleted from your enterprise account or organization and credentials stored on your enterprise are deleted.
-
In the top-right corner of GitHub AE, click your profile photo, then click Enterprise settings.
-
In the enterprise account sidebar, click GitHub Connect.
-
Next to the enterprise account or organization you'd like to disconnect, click Disable GitHub Connect.
-
Read the information about disconnecting and click Disable GitHub Connect.
