Enterprise Server 3.15 está disponível no momento como versão release candidate.

Como habilitar o GitHub Connect no GHE.com

Habilite o GitHub Connect para compartilhar dados entre o GHE.com e o sua instância do GitHub Enterprise Server.

Neste artigo

Acesse recursos e fluxos de trabalho adicionais do sua instância do GitHub Enterprise Server, habilitando o GitHub Connect. Confira "Sobre o GitHub Connect".

No GHE.com, os recursos do GitHub Connect não incluem nenhuma funcionalidade que dependa de recursos no GitHub.com.

O que acontece quando o GitHub Connect é habilitado?

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

Pré-requisitos

  • Acesso administrativo: você precisa de acesso administrativo a uma conta empresarial no GHE.com e a uma instância do GitHub Enterprise Server.

  • Requisito de versão: sua instância do GitHub Enterprise Server precisa executar o GitHub Enterprise Server 3.12 ou posterior.

  • Configuração de proxy: se estiver usando um servidor proxy, permita a conectividade com os nomes do host do GHE.com a seguir (substitua SUBDOMAIN pelo subdomínio da sua empresa).

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

    Confira "Configurando um servidor proxy Web de saída".

Etapa 1: Habilitar a conexão com o GHE.com

Por padrão, o GitHub Connect conecta o GitHub Enterprise Server ao GitHub.com. Você precisa habilitar sua instância para se conectar ao subdomínio da sua empresa do GHE.com.

Para habilitar a conexão, alguém com acesso SSH administrativo no sua instância do GitHub Enterprise Server precisa concluir as tarefas a seguir.

  1. Conecte-se via SSH ao sua instância do GitHub Enterprise Server. Se sua instância for composta por vários nós, por exemplo, se a alta disponibilidade ou a replicação geográfica estiver configurada, efetue SSH no nó primário. Se você usar um cluster, poderá efetuar SSH em qualquer nó. Substitua HOSTNAME pelo nome do host da instância ou pelo nome do host ou endereço IP de um nó. Para obter mais informações, confira "Acesar o shell administrativo (SSH)".

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Para permitir que a sua instância se conecte ao GHE.com para GitHub Connect, execute o comando a seguir. Substitua SUBDOMAIN pelo subdomínio da sua empresa no GHE.com, por exemplo, octocorp.

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

  3. Para aplicar a configuração, execute o comando a seguir.

    Note

    Durante uma execução de configuração, os serviços do sua instância do GitHub Enterprise Server podem ser reiniciados, o que poderá causar um breve tempo de inatividade para os usuários.

    Shell
    ghe-config-apply

Após a conclusão da execução, configure o GitHub Connect.

Etapa 2: Habilitar o GitHub Connect

Para habilitar o GitHub Connect, é necessário ser proprietário de uma empresa tanto no GitHub Enterprise Server quanto no GitHub Enterprise Cloud.

As pessoas com uma conta de usuário nos dois ambientes podem conectar as contas do sua instância do GitHub Enterprise Server.

  1. Entre no sua instância do GitHub Enterprise Server e no GHE.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. Em "O GitHub Connect ainda não está habilitado", clique em Habilitar o GitHub Connect . Ao clicar em Habilitar GitHub Connect , você concorda com "Termos do GitHub para produtos e recursos adicionais".

  5. À direita da conta corporativa que você deseja conectar, clique em Conectar.

  6. Escolha os recursos individuais do GitHub Connect que você deseja habilitar. Confira "Sobre o GitHub Connect".

Como habilitar novamente as conexões com o GitHub.com

Caso você precise habilitar novamente o GitHub Connect para o GitHub.com, é necessário redefinir as configurações.

  1. Conecte-se via SSH ao sua instância do GitHub Enterprise Server. Se sua instância for composta por vários nós, por exemplo, se a alta disponibilidade ou a replicação geográfica estiver configurada, efetue SSH no nó primário. Se você usar um cluster, poderá efetuar SSH em qualquer nó. Substitua HOSTNAME pelo nome do host da instância ou pelo nome do host ou endereço IP de um nó. Para obter mais informações, confira "Acesar o shell administrativo (SSH)".

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Execute o comando a seguir.

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

  3. Para aplicar a configuração, execute o comando a seguir.

    Note

    Durante uma execução de configuração, os serviços do sua instância do GitHub Enterprise Server podem ser reiniciados, o que poderá causar um breve tempo de inatividade para os usuários.

    Shell
    ghe-config-apply

  4. Habilite o GitHub Connect no GitHub.com. Confira "Enabling GitHub Connect for GitHub.com".