Enabling GitHub Connect for GHE.com

Enable GitHub Connect to share data between GHE.com and tu instancia de GitHub Enterprise Server.

En este artículo

You can access additional features and workflows on tu instancia de GitHub Enterprise Server by enabling GitHub Connect. See "Acerca 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 tu instancia de GitHub Enterprise Server and an enterprise account on GitHub Enterprise Cloud. La conexión usa HTTPS a través de los puertos 443 o 80 y está protegido por 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 "Configuración de un servidor proxy web de salida."

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 tu instancia de GitHub Enterprise Server must complete the following tasks.

  1. SSH en tu instancia de GitHub Enterprise Server Si la instancia consta de varios nodos, por ejemplo, si la alta disponibilidad o la replicación geográfica están configuradas, utiliza SSH en el nodo principal. Si usas un clúster, puedes utilizar SSH en cualquier nodo. Reemplace HOSTNAME por el nombre de host de la instancia, o el nombre de host o la dirección IP de un nodo. Para obtener más información, vea «Acceder al shell administrativo (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 tu instancia de 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 tu instancia de GitHub Enterprise Server.

  1. Sign in to tu instancia de GitHub Enterprise Server and GHE.com.

  2. En la esquina superior derecha de GitHub Enterprise Server, haz clic en la foto de perfil y luego en Configuración de empresa.

    Captura de pantalla del menú desplegable que aparece al hacer clic en la foto de perfil en GitHub Enterprise Server. La opción "Configuración de Enterprise" está resaltada en un contorno naranja oscuro.

  3. En la barra lateral de la cuenta empresarial, haz clic en GitHub Connect .

  4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "Términos de GitHub para productos y funciones adicionales."

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

Reenabling connections to GitHub.com

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

  1. SSH en tu instancia de GitHub Enterprise Server Si la instancia consta de varios nodos, por ejemplo, si la alta disponibilidad o la replicación geográfica están configuradas, utiliza SSH en el nodo principal. Si usas un clúster, puedes utilizar SSH en cualquier nodo. Reemplace HOSTNAME por el nombre de host de la instancia, o el nombre de host o la dirección IP de un nodo. Para obtener más información, vea «Acceder al shell administrativo (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 tu instancia de 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."