Enabling GitHub Connect for GHE.com

Enable GitHub Connect to share data between GHE.com and Ihre GitHub Enterprise Server-Instance.

In diesem Artikel

You can access additional features and workflows on Ihre GitHub Enterprise Server-Instance by enabling GitHub Connect. See "Informationen zu GitHub Verbinden."

On GHE.com, GitHub Connect features do not include any functionality that relies on resources on GitHub.com.

What happens when GitHub Connect is enabled?

When you enable GitHub Connect, you configure a connection between Ihre GitHub Enterprise Server-Instance and an enterprise account on GitHub Enterprise Cloud. Die Verbindung verwendet HTTPS über die Ports 443 oder 80 und wird durch TLS gesichert.

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

  • Administrative access: You need administrative access to both an enterprise account on GHE.com and a GitHub Enterprise Server instance.

  • Version requirement: Your GitHub Enterprise Server instance must run GitHub Enterprise Server 3.12 or later.

  • Proxy configuration: If using a proxy server, allow connectivity to the following GHE.com hostnames (replace SUBDOMAIN with your enterprise's subdomain).

    • SUBDOMAIN.ghe.com
    • api.SUBDOMAIN.ghe.com
    • uploads.SUBDOMAIN.ghe.com

    See "Konfigurieren eines ausgehenden Webproxyservers."

Step 1: Enable connection to GHE.com

By default, GitHub Connect connects GitHub Enterprise Server to GitHub.com. You must enable your instance to connect to your enterprise's subdomain of GHE.com.

To enable the connection, someone with administrative SSH access to deine GitHub Enterprise Server-Instanz must complete the following tasks.

  1. Melde dich über SSH bei Ihre GitHub Enterprise Server-Instance an. Wenn deine Instanz mehrere Knoten umfasst, wenn z. B. Hochverfügbarkeit oder Georeplikation konfiguriert ist, wird SSH im primären Knoten konfiguriert. Wenn du einen Cluster verwendest, kannst du SSH in einen beliebigen Knoten einfügen. Ersetzen Sie HOSTNAME durch den Hostnamen Ihrer Instanz bzw. durch den Hostnamen oder die IP-Adresse eines Knotens. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen.

    Shell
    ssh -p 122 admin@HOSTNAME

  2. To enable your instance to connect to GHE.com for GitHub Connect, run the following command. Replace SUBDOMAIN with the subdomain for your enterprise on GHE.com, for example octocorp.

    Shell
    ghe-config app.github.github-connect-ghe-com-enabled true
ghe-config app.github.github-connect-ghe-com-subdomain "SUBDOMAIN"

  3. To apply the configuration, run the following command.

    Note

    During a configuration run, services on deine GitHub Enterprise Server-Instanz may restart, which can cause brief downtime for users.

    Shell
    ghe-config-apply

After the run completes, you can configure GitHub Connect.

Step 2: Enable GitHub Connect

To enable GitHub Connect, you must be an enterprise owner on both GitHub Enterprise Server and GitHub Enterprise Cloud.

People with a user account in both environments can connect the accounts from deine GitHub Enterprise Server-Instanz.

  1. Sign in to Ihre GitHub Enterprise Server-Instance and GHE.com.

  2. Klicken Sie in der oberen rechten Ecke von GitHub Enterprise Server auf Ihr Profilfoto und dann auf Unternehmenseinstellungen.

    Screenshot des Dropdownmenüs, das angezeigt wird, wenn du auf GitHub Enterprise Server auf das Profilfoto klickst. Die Option „Unternehmenseinstellungen “ ist dunkelorange umrandet.

  3. Wähle auf der Randleiste des Unternehmenskontos die Option GitHub Connect aus.

  4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "GitHub-Nutzungsbedingungen für zusätzliche Produkte und Funktionen."

  5. To the right of the enterprise account you'd like to connect, click Connect.

  6. Choose which individual features of GitHub Connect you want to enable. See "Informationen zu GitHub Verbinden."

Reenabling connections to GitHub.com

If you need to reenable GitHub Connect for GitHub.com, you must reconfigure your settings.

  1. Melde dich über SSH bei Ihre GitHub Enterprise Server-Instance an. Wenn deine Instanz mehrere Knoten umfasst, wenn z. B. Hochverfügbarkeit oder Georeplikation konfiguriert ist, wird SSH im primären Knoten konfiguriert. Wenn du einen Cluster verwendest, kannst du SSH in einen beliebigen Knoten einfügen. Ersetzen Sie HOSTNAME durch den Hostnamen Ihrer Instanz bzw. durch den Hostnamen oder die IP-Adresse eines Knotens. Weitere Informationen findest du unter Auf die Verwaltungsshell (SSH) zugreifen.

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Run the following command.

    Shell
    ghe-config app.github.github-connect-ghe-com-enabled false

  3. To apply the configuration, run the following command.

    Note

    During a configuration run, services on deine GitHub Enterprise Server-Instanz may restart, which can cause brief downtime for users.

    Shell
    ghe-config-apply

  4. Enable GitHub Connect on GitHub.com. See "Enabling GitHub Connect for GitHub.com."