Skip to main content

Managing GitHub Connect

You can enable GitHub Connect to access additional features and workflows for sua instância do GitHub Enterprise Server.

About GitHub Connect

You can access additional features and workflows on sua instância do GitHub Enterprise Server by enabling GitHub Connect. For more information, see "About GitHub Connect."

When you enable GitHub Connect, you configure a connection between sua instância do GitHub Enterprise Server and an enterprise account on GitHub Enterprise Cloud. A conexão usa HTTPS nas portas 443 ou 80 e é protegida pelo 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

To use GitHub Connect, you must have an enterprise account on GitHub.com that uses GitHub Enterprise Cloud. You may already have GitHub Enterprise Cloud included in your plan.

Note: Your enterprise account on GitHub.com must be invoiced. Enterprise accounts on the free trial of GitHub Enterprise Cloud or that pay by credit card cannot be connected to sua instância do GitHub Enterprise Server.

If your enterprise account on GitHub.com uses IP allow lists, you must add the IP address or network for sua instância do GitHub Enterprise Server to your IP allow list on GitHub.com. For more information, see "Enforcing policies for security settings in your enterprise" in the GitHub Enterprise Cloud documentation.

To configure a connection, your proxy configuration must allow connectivity to github.com, api.github.com, and uploads.github.com. For more information, see "Configuring an outbound web proxy server."

Enabling GitHub Connect

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

  1. Sign in to sua instância do GitHub Enterprise Server and GitHub.com.

  2. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  3. Na barra lateral da conta corporativa, clique em GitHub Connect .

  4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "Termos do GitHub para produtos e recursos adicionais."

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

Disabling GitHub Connect

Enterprise owners can disable GitHub Connect.

When you disconnect from GitHub Enterprise Cloud, the GitHub Connect GitHub App is deleted from your enterprise account and credentials stored on sua instância do GitHub Enterprise Server are deleted.

  1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  2. Na barra lateral da conta corporativa, clique em GitHub Connect .

  3. Under "GitHub Connect", to the right of the enterprise account you'd like to disconnect, click Disable GitHub Connect.

  4. Read the information about disconnection, then click Disable GitHub Connect.