Skip to main content

Enabling GitHub Advanced Security for your enterprise

You can configure GitHub Enterprise Server to include GitHub Advanced Security. This provides extra features that help users find and fix security problems in their code.

Quem pode usar esse recurso?

O GitHub Advanced Security está disponível para contas corporativas no GitHub Enterprise Cloud e no GitHub Enterprise Server. Para obter mais informações, confira "Planos do GitHub."

Para obter informações sobre o GitHub Advanced Security for Azure DevOps, veja Configurar o GitHub Advanced Security for Azure DevOps no Microsoft Learn.

About enabling GitHub Advanced Security

O GitHub Advanced Security ajuda os desenvolvedores a aprimorar e manter a segurança e a qualidade do código. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

When you enable GitHub Advanced Security for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. For more information, see "Enforcing policies for code security and analysis for your enterprise."

Você também pode habilitar ou desabilitar recursos do Advanced Security por meio da API. Para obter mais informações, confira "Pontos de extremidade da API REST para verificação de segredos" na documentação da API REST.

For guidance on a phased deployment of GitHub Advanced Security, see "Introdução à adoção do GitHub Advanced Security em escala."

Checking whether your license includes GitHub Advanced Security

  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 Configurações.

  3. Em Configurações, clique em Licença .

  4. If your license includes GitHub Advanced Security, the license page includes a section showing details of current usage.

Prerequisites for enabling GitHub Advanced Security

  1. Upgrade your license for GitHub Enterprise Server to include GitHub Advanced Security. For information about licensing, see "Sobre o faturamento da Segurança Avançada do GitHub."

  2. Download the new license file. For more information, see "Fazendo o download da sua licença para o GitHub Enterprise."

  3. Upload the new license file to sua instância do GitHub Enterprise Server. For more information, see "Fazer o upload uma nova licença para o GitHub Enterprise Server."

  4. Review the prerequisites for the features you plan to enable.

Enabling and disabling GitHub Advanced Security features

Aviso: alterar esta configuração fará com que os serviços voltados para o usuário no GitHub Enterprise Server sejam reiniciados. Você deve cronometrar essa mudança com cuidado, para minimizar o tempo de inatividade dos usuários.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

  3. Na barra lateral " Administrador do site", clique em Console de Gerenciamento .

  4. Na barra lateral "Configurações", clique em Segurança.

  5. Under "Security," select the features that you want to enable and deselect any features you want to disable.

  6. Na barra lateral "Configurações", clique em Salvar configurações.

    Observação: se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  7. Aguarde a conclusão da execução de suas configurações.

When GitHub Enterprise Server has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "Configuring code scanning for your appliance."

Enabling or disabling GitHub Advanced Security features via the administrative shell (SSH)

You can enable or disable features programmatically on sua instância do GitHub Enterprise Server. For more information about the administrative shell and command-line utilities for GitHub Enterprise Server, see "Acesar o shell administrativo (SSH)" and "Utilitários de linha de comando."

For example, you can enable any GitHub Advanced Security feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.

  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. Enable features for GitHub Advanced Security.

    • To enable code scanning, enter the following commands.

      Shell
      ghe-config app.minio.enabled true
      ghe-config app.code-scanning.enabled true
      
    • To enable secret scanning, enter the following command.

      Shell
      ghe-config app.secret-scanning.enabled true
      
    • To enable the dependency graph, enter the following command.

      Shell
      ghe-config app.dependency-graph.enabled true
      
  3. Optionally, disable features for GitHub Advanced Security.

    • To disable code scanning, enter the following commands.

      Shell
      ghe-config app.code-scanning.enabled false
      
      • Optionally, if you disable code scanning, you can also disable the internal MinIO service for GitHub Advanced Security. If Dependabot updates are enabled for the instance and you want to disable this service, you must also disable Dependabot updates. Disabling the service does not affect MinIO storage for GitHub Actions or GitHub Packages. For more information about Dependabot updates, see "Enabling Dependabot for your enterprise."

        • To disable Dependabot updates, enter the following command.

          Shell
          ghe-config app.dependabot.enabled false
          
        • To disable MinIO, enter the following command.

          Shell
          ghe-config app.minio.enabled false
          
    • To disable secret scanning, enter the following command.

      Shell
      ghe-config app.secret-scanning.enabled false
      
    • To disable the dependency graph, enter the following command.

      ghe-config app.dependency-graph.enabled false
      
  4. Para aplicar a configuração, execute o comando a seguir.

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

    Shell
    ghe-config-apply
    
  5. Aguarde a conclusão da execução de suas configurações.