jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-30 06:01:34 -05:00
Code Issues Projects Releases Wiki Activity
Files
45bd0727f154a574efe194e0ecc26fbf4e20f2fc
docs/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud.md
Lucas Costi cde40f4847 [DO NOT MERGE] GitHub Enterprise Server 3.2 release candidate (#20666) 
* Issue template stuff for creating megabranch

* Fix placeholder YAML

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Add release candidate banner

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* [GHES 3.2]: Remove final notes about machine man preview (GA) (#20939)

* update search indexes

* update search indexes

* Add GHES versioning to "Managing your theme settings" (#20950)

* update search indexes

* [GHES 3.2]: Fix versioning for security alerts (#20761)

* made a start

* rework

* move image to an enterprise 3.1 folder

* forgot to commit

* simplify reusable

* update search indexes

* update search indexes

* update search indexes

* Updated basic 3.2 REST fiels after package change

These will be overwritten before release by the new description files when the 3.2 description is properly published

* update search indexes

* GHAE feature flag for `security alerts` custom notification option (#20979)

* made a start

* rework

* move image to an enterprise 3.1 folder

* forgot to commit

* simplify reusable

* add GHAE feature flag

* remove spurious spaces I had added

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Update versioning (#21121)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* update search indexes

* Add the new service (#21060)

* update search indexes

* update search indexes

* update search indexes

* Fix parent category index versioning for security overview

* update search indexes

* [GHES 3.2] Add documentation for GHES Referrer Policy Admin setting (#20910)

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* update search indexes

* update search indexes

* Update "Review hardware considerations" table (#21208)

Performance improvements resulted in higher maximum job throughput and the new benchmarks need to be shared with current and potential customers.

* update search indexes

* Version new GHES 3.2 Actions tested performance (#21212)

* update search indexes

* Update "Review hardware considerations" table v2

Feedback from additional reviewers requires an update to the benchmarks previously merged.

* update search indexes

* update search indexes

* [GHES 3.2] - Dependency Graph: Simplified enablement in GHES (GA) (#21078)

* document UI button for dependency graph GHES 3.2

* update search indexes

* Update getting-started-with-github-actions-for-github-enterprise-server.md

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* [GHES 3.2] Release candidate 1 release notes (#20799)

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: bwestover <bwestover@github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Grey Baker <greysteil@github.com>
Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com>
Co-authored-by: William Bartholomew <iamwillbar@github.com>

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Update OpenAPI Descriptions for GHES 3.2 (#21377)

Also contains a rollup of other unmerged OpenAPI changes

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* update search indexes

Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: GitHub Actions <action@github.com>
Co-authored-by: Docubot <67483024+docubot@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Matthias Wenz <matthiaswenz@github.com>
Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Steve-Glass <84886334+Steve-Glass@users.noreply.github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: bwestover <bwestover@github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Grey Baker <greysteil@github.com>
Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com>
Co-authored-by: William Bartholomew <iamwillbar@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2021-09-09 08:56:20 -07:00

66 lines
7.0 KiB
Markdown
Raw Blame History

---
title: Connecting GitHub Enterprise Server to GitHub Enterprise Cloud
intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location_enterprise %} and {% data variables.product.prodname_ghe_cloud %}.'
redirect_from:
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com/
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com
- /enterprise/admin/developer-workflow/connecting-github-enterprise-server-to-githubcom/
- /enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud
- /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
- /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.'
versions:
ghes: '*'
type: how_to
topics:
- Enterprise
- GitHub Connect
- Infrastructure
- Networking
shortTitle: Connect to GHEC
---
## About {% data variables.product.prodname_github_connect %}
To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location_enterprise %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account.
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](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)."
After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/installation/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud)."
When you connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_ghe_cloud %}, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection:
- The public key portion of your {% data variables.product.prodname_ghe_server %} license
- A hash of your {% data variables.product.prodname_ghe_server %} license
- The customer name on your {% data variables.product.prodname_ghe_server %} license
- The hostname of {% data variables.product.product_location_enterprise %}
- The version of {% data variables.product.product_location_enterprise %}
- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location_enterprise %}
- The authentication token that's used by {% data variables.product.product_location_enterprise %} to make requests to {% data variables.product.prodname_dotcom_the_website %}
Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.prodname_ghe_server %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}.
{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}.
- An authentication token, which is valid for one hour
- A private key, which is used to generate a new authentication token
Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.prodname_ghe_server %}.
For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)."
## Enabling {% data variables.product.prodname_github_connect %}
1. Sign in to {% data variables.product.product_location_enterprise %} and {% data variables.product.prodname_dotcom_the_website %}.
{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}
1. Under "{% data variables.product.prodname_dotcom_the_website %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the <a href="/articles/github-connect-addendum-to-the-github-enterprise-license-agreement/" class="dotcom-only">{% data variables.product.prodname_github_connect %} Addendum to the {% data variables.product.prodname_enterprise %} License Agreement</a>.
![Enable GitHub Connect button](/assets/images/enterprise/business-accounts/enable-github-connect-button.png)
1. Next to the enterprise account or organization you'd like to connect, click **Connect**.
![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png)
## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from {% data variables.product.product_location_enterprise %}
When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location_enterprise %} are deleted.
{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}
1. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**.
![Disable GitHub Connect button next to an enterprise account or organization name](/assets/images/enterprise/business-accounts/disable-github-connect-button.png)
1. Read the information about disconnecting and click **Disable {% data variables.product.prodname_github_connect %}**.
![Modal with warning information about disconnecting and confirmation button](/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png)
Reference in New Issue View Git Blame Copy Permalink