跳至主要内容

将自托管运行器应用程序配置为服务

您可以将自托管运行器应用程序配置为服务,以便在机器启动时自动启动运行器应用程序。

平台导航

注意

在您将运行器配置为服务之前,必须先将其添加到 GitHub。有关更多信息,请参阅“添加自托管运行器”。

对于使用systemd的 Linux 系统,您可以使用在成功将运行器添加到 GitHub 后创建的svc.sh脚本,以安装和管理将应用程序用作服务。

在运行器机器上,在您安装自托管运行器应用程序的目录中打开一个 Shell。使用以下命令安装和管理自托管运行器服务。

注意

在 Windows 上将自托管运行器应用程序配置为服务是应用程序配置过程的一部分。如果您已经配置了自托管运行器应用程序但未选择将其配置为服务,则必须从 GitHub 中删除运行器并重新配置应用程序。重新配置应用程序时,请选择将应用程序配置为服务的选项。

有关更多信息,请参阅“删除自托管运行器”和“添加自托管运行器”。

您可以通过 Windows 的**服务**应用程序管理运行器服务,也可以使用 PowerShell 运行以下命令。

注意

在您将运行器配置为服务之前,必须先将其添加到 GitHub。有关更多信息,请参阅“添加自托管运行器”。

在运行器机器上,在您安装自托管运行器应用程序的目录中打开一个 Shell。使用以下命令安装和管理自托管运行器服务。

安装服务

  1. 如果自托管运行器应用程序当前正在运行,请停止它。

  2. 使用以下命令安装服务

    sudo ./svc.sh install
    
  3. 或者,该命令可以接收一个可选的 user 参数,以将服务安装为不同的用户。

    ./svc.sh install USERNAME
    

安装服务

  1. 如果自托管运行器应用程序当前正在运行,请停止它。

  2. 使用以下命令安装服务

    ./svc.sh install
    

启动服务

使用以下命令启动服务

sudo ./svc.sh start
Start-Service "actions.runner.*"
./svc.sh start

检查服务状态

使用以下命令检查服务状态

sudo ./svc.sh status
Get-Service "actions.runner.*"
./svc.sh status

有关查看自托管运行器状态的更多信息,请参阅“监控和故障排除自托管运行器”。

停止服务

使用以下命令停止服务

sudo ./svc.sh stop
Stop-Service "actions.runner.*"
./svc.sh stop

卸载服务

  1. 如果服务当前正在运行,请停止它。

  2. 使用以下命令卸载服务

    sudo ./svc.sh uninstall
    
    Remove-Service "actions.runner.*"
    
    ./svc.sh uninstall
    

自定义自托管运行器服务

如果您不想使用上述默认的 systemd 服务配置,则可以创建自定义服务或使用您喜欢的任何服务机制。请考虑使用 actions-runner/bin/actions.runner.service.template 中的 serviced 模板作为参考。如果您使用自定义服务,则必须始终使用 runsvc.sh 入口点调用自托管运行器服务。

自定义自托管运行器服务

如果您不想使用上述默认的 launchd 服务配置,则可以创建自定义服务或使用您喜欢的任何服务机制。请考虑使用 actions-runner/bin/actions.runner.plist.template 中的 plist 模板作为参考。如果您使用自定义服务,则必须始终使用 runsvc.sh 入口点调用自托管运行器服务。