1
0
mirror of synced 2026-01-06 15:01:04 -05:00
Files
docs/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md
Vanessa Yuen 3df90fc9b8 Hello git history spelunker!
Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
2020-09-27 14:10:11 +02:00

7.3 KiB

title, intro, redirect_from, permissions, versions
title intro redirect_from permissions versions
Connecting GitHub Enterprise Server to GitHub Enterprise Cloud After you enable {{ site.data.variables.product.prodname_github_connect }}, you can share specific features and workflows between {{ site.data.variables.product.product_location_enterprise }} and {{ site.data.variables.product.prodname_ghe_cloud }}.
/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
Site administrators for {{ site.data.variables.product.prodname_ghe_server }} who are also owners of a {{ site.data.variables.product.prodname_ghe_cloud }} organization or enterprise account can enable {{ site.data.variables.product.prodname_github_connect }}.
enterprise-server
*

About {{ site.data.variables.product.prodname_github_connect }}

To enable {{ site.data.variables.product.prodname_github_connect }}, you must configure the connection in both {{ site.data.variables.product.product_location_enterprise }} and in your {{ site.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 {{ site.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 {{ site.data.variables.product.prodname_ghe_server }} and {{ site.data.variables.product.prodname_ghe_cloud }}](/enterprise/{{ currentVersion }}/admin/installation/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud)."

When you connect {{ site.data.variables.product.product_location_enterprise }} to {{ site.data.variables.product.prodname_ghe_cloud }}, a record on {{ site.data.variables.product.prodname_dotcom_the_website }} stores information about the connection:

  • The public key portion of your {{ site.data.variables.product.prodname_ghe_server }} license
  • A hash of your {{ site.data.variables.product.prodname_ghe_server }} license
  • The customer name on your {{ site.data.variables.product.prodname_ghe_server }} license
  • The hostname of {{ site.data.variables.product.product_location_enterprise }}
  • The version of {{ site.data.variables.product.product_location_enterprise }}
  • The organization or enterprise account on {{ site.data.variables.product.prodname_dotcom_the_website }} that's connected to {{ site.data.variables.product.product_location_enterprise }}
  • The authentication token that's used by {{ site.data.variables.product.product_location_enterprise }} to make requests to {{ site.data.variables.product.prodname_dotcom_the_website }}

Enabling {{ site.data.variables.product.prodname_github_connect }} also creates a {{ site.data.variables.product.prodname_github_app }} owned by your {{ site.data.variables.product.prodname_ghe_cloud }} organization or enterprise account. {{ site.data.variables.product.prodname_ghe_server }} uses the {{ site.data.variables.product.prodname_github_app }}'s credentials to make requests to {{ site.data.variables.product.prodname_dotcom_the_website }}.

{{ site.data.variables.product.prodname_ghe_server }} stores credentials from the {{ site.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 {{ site.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 {{ site.data.variables.product.prodname_github_connect }} will not allow {{ site.data.variables.product.prodname_dotcom_the_website }} users to make changes to {{ site.data.variables.product.prodname_ghe_server }}.

{% if currentVersion ver_gt "enterprise-server@2.18" %} For more information about managing enterprise accounts using the GraphQL API, see "Enterprise accounts." {% endif %}

Enabling {{ site.data.variables.product.prodname_github_connect }}

  1. Sign in to {{ site.data.variables.product.product_location_enterprise }} and {{ site.data.variables.product.prodname_dotcom_the_website }}. {{ site.data.reusables.enterprise_site_admin_settings.access-settings }} {{ site.data.reusables.enterprise_site_admin_settings.business }} {{ site.data.reusables.enterprise-accounts.settings-tab }} {{ site.data.reusables.enterprise-accounts.github-connect-tab }}
  2. Under "{{ site.data.variables.product.prodname_dotcom_the_website }} is not enabled yet", click Enable {{ site.data.variables.product.prodname_github_connect }}. By clicking Enable {{ site.data.variables.product.prodname_github_connect }}, you agree to the {{ site.data.variables.product.prodname_github_connect }} Addendum to the {{ site.data.variables.product.prodname_enterprise }} License Agreement. Enable GitHub Connect button
  3. Next to the enterprise account or organization you'd like to connect, click Connect. Connect button next to an enterprise account or business

Disconnecting a {{ site.data.variables.product.prodname_ghe_cloud }} organization or enterprise account from {{ site.data.variables.product.product_location_enterprise }}

When you disconnect from {{ site.data.variables.product.prodname_ghe_cloud }}, the {{ site.data.variables.product.prodname_github_connect }} {{ site.data.variables.product.prodname_github_app }} is deleted from your enterprise account or organization and credentials stored on {{ site.data.variables.product.product_location_enterprise }} are deleted.

{{ site.data.reusables.enterprise_site_admin_settings.access-settings }} {{ site.data.reusables.enterprise_site_admin_settings.business }} {{ site.data.reusables.enterprise-accounts.settings-tab }} {{ site.data.reusables.enterprise-accounts.github-connect-tab }} 5. Next to the enterprise account or organization you'd like to disconnect, click Disable {{ site.data.variables.product.prodname_github_connect }}. Disable GitHub Connect button next to an enterprise account or organization name 6. Read the information about disconnecting and click Disable {{ site.data.variables.product.prodname_github_connect }}. Modal with warning information about disconnecting and confirmation button