Activation de GitHub Connect pour GHE.com

Vous pouvez accéder à des fonctionnalités et workflows supplémentaires pour votre instance GitHub Enterprise Server en activant GitHub Connect. Consultez « À propos de GitHub Connect ».

Sur GHE.com, les fonctionnalités GitHub Connect n’incluent aucune fonctionnalité s’appuyant sur les ressources sur GitHub.com.

Que se passe-t-il quand GitHub Connect est activé ?

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

Prérequis

• Accès administratif : Vous avez besoin d’un accès administratif à la fois à un compte d’entreprise sur GHE.com et à une instance GitHub Enterprise Server.

• Exigence de version : Votre instance de GitHub Enterprise Server doit exécuter GitHub Enterprise Server 3.12 ou ultérieure.

• **Configuration proxy **: si vous utilisez un serveur proxy, autorisez la connectivité aux noms d’hôte suivants GHE.com (remplacez SUBDOMAIN par le sous-domaine de votre entreprise).

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

  Consultez « Configuration d’un serveur proxy web de trafic sortant ».

Étape 1 : Activez la connexion à GHE.com

Par défaut, GitHub Connect connecte GitHub Enterprise Server à GitHub.com. Vous devez activer votre instance pour vous connecter au sous-domaine de GHE.com de votre entreprise.

Pour activer la connexion, quelqu’un disposant d’un accès SSH administratif à votre instance GitHub Enterprise Server doit compléter les tâches suivantes.

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. Pour permettre à votre instance de se connecter à GHE.com pour GitHub Connect, exécutez la commande suivante. Remplacez SUBDOMAIN par le sous-domaine de votre entreprise sur GHE.com, par exemple octocorp.

   Shell

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

3. Pour appliquer la configuration, exécutez la commande suivante.

   Note

   Durant une exécution de configuration, les services sur votre instance GitHub Enterprise Server peuvent redémarrer, ce qui peut entraîner un bref temps d’arrêt pour les utilisateurs.

   Shell

   ghe-config-apply
   

Une fois l’exécution terminée, vous pouvez configurer GitHub Connect.

Étape 2 : Activez GitHub Connect

Pour activer GitHub Connect, vous devez être propriétaire d’entreprise sur GitHub Enterprise Server et sur GitHub Enterprise Cloud.

Les personnes disposant d’un compte d’utilisateur dans les deux environnements peuvent connecter les comptes depuis votre instance GitHub Enterprise Server.

1. Connectez-vous à votre instance GitHub Enterprise Server et à 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. Sous « GitHub Connect n’est pas encore activé », cliquez sur Activer GitHub Connect . En cliquant sur Activer GitHub Connect , vous acceptez les « Conditions GitHub pour les produits et fonctionnalités supplémentaires ».

5. À droite du compte d’entreprise que vous souhaitez connecter, cliquez sur Connexion.

6. Choisissez quelles fonctionnalités individuelles de GitHub Connect vous souhaitez activer. Consultez « À propos de GitHub Connect ».

Réactivez les connexions à GitHub.com

Si vous avez besoin de réactiver GitHub Connect pour GitHub.com, vous devez reconfigurer vos paramètres.

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. Exécutez la commande suivante :

   Shell

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

3. Pour appliquer la configuration, exécutez la commande suivante.

   Note

   Durant une exécution de configuration, les services sur votre instance GitHub Enterprise Server peuvent redémarrer, ce qui peut entraîner un bref temps d’arrêt pour les utilisateurs.

   Shell

   ghe-config-apply
   

4. Activez GitHub Connect sur GitHub.com. Consultez « Enabling GitHub Connect for GitHub.com ».