Adding self-hosted runners

You can add a self-hosted runner to a repository, an organization, or an enterprise.

If you are an organization or enterprise administrator, you might want to add your self-hosted runners at the organization or enterprise level. This approach makes the runner available to multiple repositories in your organization or enterprise, and also lets you to manage your runners in one place.

For information on supported operating systems for self-hosted runners, or using self-hosted runners with a proxy server, see "About self-hosted runners."

You can set up automation to scale the number of self-hosted runners. For more information, see "Autoscaling with self-hosted runners."

Prerequisites

• Você precisa ter acesso ao computador que usará como um executor auto-hospedado no seu ambiente.

• Para obter mais informações, confira "Sobre os executores auto-hospedados".

Adding a self-hosted runner to a repository

You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

1. On GitHub.com, navigate to the main page of the repository.

2. Abaixo do nome do repositório, clique em Configurações.

3. In the left sidebar, click Actions, then click Runners.

4. Click New self-hosted runner.

5. Selecione a imagem e a arquitetura do sistema operacional do computador do executor auto-hospedado.

6. Você verá instruções mostrando como baixar o executor e instalá-lo em sua máquina de executor auto-hospedada.

   Abra um shell em sua máquina de executor auto-hospedado e execute cada comando shell na ordem mostrada.

   Observação: no Windows, caso você deseje instalar o aplicativo do executor auto-hospedado como um serviço, abra um shell com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo do executor auto-hospedado para que as contas do sistema do Windows possam acessar o diretório do executor.

   As instruções te ajudam a completar estas tarefas:

   • Transferindo e extraindo o aplicativo do executor auto-hospedado.
   • Executar o script config para configurar o aplicativo do executor auto-hospedado e registrá-lo no GitHub Actions. O script config exige a URL de destino e um token de tempo limitado gerado automaticamente para autenticar a solicitação.
     • No Windows, o script config também pergunta se você deseja instalar o aplicativo do executor auto-hospedado como um serviço. Para Linux e macOS, você pode instalar um serviço depois de terminar de adicionar o executor. Para obter mais informações, confira "Como configurar o aplicativo do executor auto-hospedado como um serviço".
   • Executando o aplicativo do executor auto-hospedado para conectar a máquina ao GitHub Actions.

Verificando se o seu executor auto-hospedado foi adicionado com sucesso

Depois de completar as etapas para adicionar um executor auto-hospedado, o executor e seu status serão listados em "Runners".

A aplicação dos executores auto-hospedados deve estar activa para que o executor aceite os trabalhos. Quando o aplicativo do executor estiver conectado a GitHub e pronto para receber trabalhos, você verá a seguinte mensagem no terminal da máquina.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

For more information, see "Monitoring and troubleshooting self-hosted runners."

Adding a self-hosted runner to an organization

You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

1. On GitHub.com, navigate to the main page of the organization.

2. No nome da sua organização, clique em Configurações.

3. In the left sidebar, click Actions, then click Runners.

4. Click New runner, then click New self-hosted runner.

5. Selecione a imagem e a arquitetura do sistema operacional do computador do executor auto-hospedado.

6. Você verá instruções mostrando como baixar o executor e instalá-lo em sua máquina de executor auto-hospedada.

   Abra um shell em sua máquina de executor auto-hospedado e execute cada comando shell na ordem mostrada.

   Observação: no Windows, caso você deseje instalar o aplicativo do executor auto-hospedado como um serviço, abra um shell com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo do executor auto-hospedado para que as contas do sistema do Windows possam acessar o diretório do executor.

   As instruções te ajudam a completar estas tarefas:

   • Transferindo e extraindo o aplicativo do executor auto-hospedado.
   • Executar o script config para configurar o aplicativo do executor auto-hospedado e registrá-lo no GitHub Actions. O script config exige a URL de destino e um token de tempo limitado gerado automaticamente para autenticar a solicitação.
     • No Windows, o script config também pergunta se você deseja instalar o aplicativo do executor auto-hospedado como um serviço. Para Linux e macOS, você pode instalar um serviço depois de terminar de adicionar o executor. Para obter mais informações, confira "Como configurar o aplicativo do executor auto-hospedado como um serviço".
   • Executando o aplicativo do executor auto-hospedado para conectar a máquina ao GitHub Actions.

Verificando se o seu executor auto-hospedado foi adicionado com sucesso

Depois de completar as etapas para adicionar um executor auto-hospedado, o executor e seu status serão listados em "Runners".

A aplicação dos executores auto-hospedados deve estar activa para que o executor aceite os trabalhos. Quando o aplicativo do executor estiver conectado a GitHub e pronto para receber trabalhos, você verá a seguinte mensagem no terminal da máquina.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

For more information, see "Monitoring and troubleshooting self-hosted runners."

Adding a self-hosted runner to an enterprise

If you use GitHub Enterprise Cloud, you can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization admins are then able to control which repositories can use it. For more information, see the GitHub Enterprise Cloud documentation.