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."

Prerequisites

• GitHub Actions deve ser habilitado para GitHub Enterprise Server. Um administrador do site pode habilitar e configurar GitHub Actions na sua instância. Para obter mais informações, consulte "Primeiros passos com GitHub Actions for GitHub Enterprise Server".

• Você precisa ter acesso �  máquina que você usará como um executor auto-hospedado em seu ambiente.

• A conexão entre runners auto-hospedados e GitHub Enterprise Server é por meio de HTTP (porta 80) ou HTTPS (porta 443). Para garantir conectividade por meio de HTTPS, configure TLS para your GitHub Enterprise Server instance. Para obter mais informações, consulte "Configurando TLS". Para obter mais informações, consulte "Sobre 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. No your GitHub Enterprise Server instance, navegue até a página principal do repositório.

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

3. In the left sidebar, click Actions.

4. Under "Self-hosted runners", click Add runner.

5. Select the operating system image and architecture of your self-hosted runner machine.

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.

   Nota: No Windows, se você quiser instalar a aplicação de executor auto-hospedada como um serviço, você deve abrir um shell com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo runner auto-hospedado para que as contas de sistema 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.
   • Executando o script config para configurar a aplicação de executor auto-hospedada e registrá-lo no GitHub Actions. O script config requer 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ê gostaria de instalar o aplicativo de execução 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, consulte "Configuring the self-hosted runner application as a service."
   • 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 "Executores auto-hospedados".

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 Enterprise Server 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. No your GitHub Enterprise Server instance, navegue para a página principal da organização.

2. Abaixo do nome da sua organização, clique em Settings.

   

3. In the left sidebar, click Actions.

4. Under "Self-hosted runners", click Add runner."

5. Select the operating system image and architecture of your self-hosted runner machine.

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.

   Nota: No Windows, se você quiser instalar a aplicação de executor auto-hospedada como um serviço, você deve abrir um shell com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo runner auto-hospedado para que as contas de sistema 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.
   • Executando o script config para configurar a aplicação de executor auto-hospedada e registrá-lo no GitHub Actions. O script config requer 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ê gostaria de instalar o aplicativo de execução 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, consulte "Configuring the self-hosted runner application as a service."
   • 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 "Executores auto-hospedados".

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 Enterprise Server 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

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.

New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "Managing access to self-hosted runners."

Para adicionar um executor auto-hospedado a uma empresa, você deve ser um proprietário corporativo.

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

2. Na barra lateral da conta corporativa, clique em Policies.

3. Em " Policies (Políticas)", clique em Actions (Ações).

4. Clique na aba Executores auto-hospedados .

5. Clique em Adicionar novo e depois clique em Novo executor.

6. Select the operating system image and architecture of your self-hosted runner machine.

7. 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.

   Nota: No Windows, se você quiser instalar a aplicação de executor auto-hospedada como um serviço, você deve abrir um shell com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo runner auto-hospedado para que as contas de sistema 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.
   • Executando o script config para configurar a aplicação de executor auto-hospedada e registrá-lo no GitHub Actions. O script config requer 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ê gostaria de instalar o aplicativo de execução 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, consulte "Configuring the self-hosted runner application as a service."
   • 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 "Executores auto-hospedados".

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 Enterprise Server 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."

Making enterprise runners available to repositories

By default, runners in an enterprise's "Default" self-hosted runner group are available to all organizations in the enterprise, but are not available to all repositories in each organization.

To make an enterprise-level self-hosted runner group available to an organization repository, you might need to change the organization's inherited settings for the runner group to make the runner available to repositories in the organization.

For more information on changing runner group access settings, see "Managing access to self-hosted runners using groups."

Further reading

• "Getting started with self-hosted runners for your enterprise"