Enabling GitHub Connect for GHE.com

You can access additional features and workflows on votre instance GitHub Enterprise Server by enabling GitHub Connect. See "À propos de GitHub Connect."

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 votre instance GitHub Enterprise Server and an enterprise account on GitHub Enterprise Cloud. La connexion utilise HTTPS sur les ports 443 ou 80 et est sécurisée par TLS.

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 "Configuration d’un serveur proxy web de trafic sortant."

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 votre instance GitHub Enterprise Server must complete the following tasks.

1. Connexion SSH à votre instance GitHub Enterprise Server. Si votre instance comprend plusieurs nœuds, par exemple si la haute disponibilité ou la géoréplication sont configurées, connectez-vous via SSH au nœud principal. Si vous utilisez un cluster, vous pouvez vous connecter via SSH à n’importe quel nœud. Remplacez HOSTNAME par le nom d’hôte de votre instance, le nom d’hôte ou l’adresse IP d’un nœud. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) ».

   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 votre instance GitHub Enterprise Server 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 votre instance GitHub Enterprise Server.

1. Sign in to votre instance GitHub Enterprise Server and GHE.com.

2. Dans le coin supérieur droit de GitHub Enterprise Server, cliquez sur votre photo de profil, puis sur Paramètres d’entreprise.

   

3. Dans la barre latérale du compte d’entreprise, cliquez sur GitHub Connect .

4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "Conditions GitHub pour les produits et fonctionnalités supplémentaires."

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 "À propos de GitHub Connect."

Reenabling connections to GitHub.com

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

1. Connexion SSH à votre instance GitHub Enterprise Server. Si votre instance comprend plusieurs nœuds, par exemple si la haute disponibilité ou la géoréplication sont configurées, connectez-vous via SSH au nœud principal. Si vous utilisez un cluster, vous pouvez vous connecter via SSH à n’importe quel nœud. Remplacez HOSTNAME par le nom d’hôte de votre instance, le nom d’hôte ou l’adresse IP d’un nœud. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) ».

   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 votre instance GitHub Enterprise Server 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."