Usar um servidor proxy com os executores auto-hospedados

Você pode configurar executores auto-hospedados para usar um servidor proxy para comunicar-se com GitHub Enterprise Server.

Neste artigo

Note

No momento, não há suporte para executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Configurar um servidor proxy usando variáveis de ambiente

Se você precisar de um executor auto-hospedado para comunicar-se por meio de um servidor proxy, o aplicativo do executor auto-hospedado usará as configurações proxy definidas nas variáveis do ambiente a seguir:

  • https_proxy: URL de proxy para o tráfego HTTPS. Se necessário, você também poderá incluir credenciais de autenticação básica. Por exemplo:
    • http://proxy.local
    • http://192.168.1.1:8080
    • http://username:password@proxy.local
  • http_proxy: URL de proxy para o tráfego HTTP. Se necessário, você também poderá incluir credenciais de autenticação básica. Por exemplo:
    • http://proxy.local
    • http://192.168.1.1:8080
    • http://username:password@proxy.local
  • no_proxy: lista separada por vírgula de hosts que não devem usar um proxy. Somente os nomes de host são permitidos no no_proxy, você não pode usar endereços IP. Por exemplo:
    • example.com
    • example.com,myserver.local:443,example.org

As variáveis do ambiente proxy são lidas quando o aplicativo do executor auto-hospedado inicia. Portanto, você deve definir as variáveis do ambiente antes de configurar ou iniciar o aplicativo do executor auto-hospedado. Se sua configuração de proxy for mudada, você deverá reiniciar o aplicativo executor auto-hospedado.

Note

Para evitar problemas, é uma boa prática tratar as variáveis de ambiente como com diferenciação de maiúsculas e minúsculas, independentemente do comportamento do sistema operacional e do shell que você está usando.

No Windows, os nomes da variável de ambiente proxy não diferenciam maiúsculas de minúsculas. Nos sistemas Linux e macOS, recomendamos que você use variáveis de ambiente em minúscula. Caso tenha uma variável de ambiente em letras minúsculas e maiúsculas no Linux ou macOS (por exemplo, https_proxy e HTTPS_PROXY), o aplicativo executor auto-hospedado usará a variável de ambiente em minúsculas.

A conexão entre os executores auto-hospedados e o GitHub Enterprise Server é feita por HTTP (porta 80) ou HTTPS (porta 443). Para garantir a conectividade por HTTPS, configure o TLS para o GitHub Enterprise Server. Para obter mais informações, confira "Configurar o TLS".

Usar um arquivo .env para definir a configuração de proxy

Se não for prático definir variáveis de ambiente, defina as variáveis da configuração de proxy em um arquivo chamado .env no diretório do aplicativo do executor auto-hospedado (ou seja, o diretório no qual você baixou e descompactou o software executor). Por exemplo, isso pode ser necessário se você desejar configurar um aplicativo executor como um serviço em uma conta de sistema. Quando o aplicativo executor é iniciado, ele lê as variáveis definidas em .env para a configuração de proxy.

Exemplo de proxy reverso .env

https_proxy=http://proxy.local:8080
no_proxy=example.com,myserver.local:443

Definir configuração de proxy para contêineres Docker

Se você usar ações do contêiner Dock ou contêineres de serviço nos seus fluxos de trabalho, você também deverá configurar o Docker para usar o seu servidor proxy além de definir as variáveis do ambiente acima.

Para obter informações sobre a configuração necessária do Docker, confira Configurar o Docker para usar um servidor proxy na documentação do Docker.