Configurar o aplicativo do executor auto-hospedado como um serviço

Você pode configurar o aplicativo do executor auto-hospedado como um serviço para que inicie o aplicativo do executor automaticamente quando a máquina for iniciada.

Platform navigation

Neste artigo

Observação

No momento, não há suporte para executores hospedados no GitHub Enterprise Server no GitHub.

Observação

Você precisa adicionar um executor ao GitHub antes de poder configurar o aplicativo executor auto-hospedado como um serviço. Para saber mais, confira Adicionar executores auto-hospedados.

Para sistemas Linux que usam systemd, você pode usar o script svc.sh que é criado após incluir com êxito o executor a fim de instalar e gerenciar usando o aplicativo como um serviço.

No computador do executor, abra um shell no diretório em que você instalou o aplicativo do executor auto-hospedado. Utilize os comandos abaixo para instalar e gerenciar o serviço de runner auto-hospedado.

Observação

Configurar o aplicativo de execução auto-hospedado como um serviço no Windows faz parte do processo de configuração do aplicativo. Se você já configurou o aplicativo de runner auto-hospedado, mas não escolheu configurá-lo como um serviço, você deve remover o runner do GitHub e reconfigurar o aplicativo. Ao reconfigurar o aplicativo, selecione a opção para configurar o aplicativo como um serviço.

Para saber mais, confira Remover executores auto-hospedados e Adicionar executores auto-hospedados.

Você pode gerenciar o serviço de executor no aplicativo Serviços Windows ou usar o PowerShell para executar os comandos abaixo.

Observação

Você precisa adicionar um executor ao GitHub antes de poder configurar o aplicativo executor auto-hospedado como um serviço. Para saber mais, confira Adicionar executores auto-hospedados.

No computador do executor, abra um shell no diretório em que você instalou o aplicativo do executor auto-hospedado. Utilize os comandos abaixo para instalar e gerenciar o serviço de runner auto-hospedado.

Instalar o serviço

  1. Interrompa o aplicativo do executor auto-hospedado se ele estiver em execução no momento.

  2. Instale o serviço com o comando a seguir:

    sudo ./svc.sh install

  3. Como alternativa, o comando usa um argumento user opcional para instalar o serviço como outro usuário.

    ./svc.sh install USERNAME

Instalar o serviço

  1. Interrompa o aplicativo do executor auto-hospedado se ele estiver em execução no momento.

  2. Instale o serviço com o comando a seguir:

    ./svc.sh install

Iniciar o serviço

Inicie o serviço com o seguinte comando:

sudo ./svc.sh start

Observação

Em sistemas Linux baseados em Debian (como Debian ou Ubuntu) com needrestart habilitado, needrestart você pode impedir a reinicialização do serviço executor durante um trabalho de fluxo de trabalho configurando-o para ignorar o serviço executor. Execute o comando a seguir:

echo '$nrconf{override_rc}{qr(^actions\.runner\..+\.service$)} = 0;' | sudo tee /etc/needrestart/conf.d/actions_runner_services.conf

Start-Service "actions.runner.*"

./svc.sh start

Verificando o status do serviço

Verifique o status do serviço com o comando a seguir:

sudo ./svc.sh status

Get-Service "actions.runner.*"

./svc.sh status

Para obter mais informações sobre como visualizar o status do seu executor auto-hospedado, consulte Monitorar e solucionar problemas de executores auto-hospedados.

Interromper o serviço

Interrompa o serviço com o comando a seguir:

sudo ./svc.sh stop

Stop-Service "actions.runner.*"

./svc.sh stop

Desinstalando o serviço

  1. Interrompa o serviço se estiver em execução.

  2. Desinstale o serviço com o comando a seguir:

    sudo ./svc.sh uninstall

```shell
Remove-Service "actions.runner.*"
```

</div>

```shell
./svc.sh uninstall
```

</div>

Personalizar o serviço do executor auto-hospedado

Caso não deseje usar a configuração padrão do serviço systemd acima, crie um serviço personalizado ou use o mecanismo de serviço que preferir. Considere o uso do modelo serviced localizado em actions-runner/bin/actions.runner.service.template como uma referência. Se você usa um serviço personalizado, o serviço do executor auto-hospedado precisa sempre ser acessado por meio do ponto de entrada runsvc.sh.

Personalizar o serviço do executor auto-hospedado

Se você não desejar usar a configuração-padrão do serviço do launchd acima, você poderá criar um serviço personalizado ou usar o mecanismo de serviço que preferir. Considere o uso do modelo plist localizado em actions-runner/bin/actions.runner.plist.template como uma referência. Se você usa um serviço personalizado, o serviço do executor auto-hospedado precisa sempre ser acessado por meio do ponto de entrada runsvc.sh.