将自托管 Runner 应用程序配置为服务

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

平台导航

本文内容

注意

您必须先将 Runner 添加到 GitHub，然后才能将自托管 Runner 应用程序配置为服务。有关更多信息，请参阅“添加自托管 Runner”。

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

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

注意

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

有关更多信息，请参阅“删除自托管 Runner”和“添加自托管 Runner”。

您可以在 Windows **服务**应用程序中管理 Runner 服务，也可以使用 PowerShell 运行以下命令。

注意

您必须先将 Runner 添加到 GitHub，然后才能将自托管 Runner 应用程序配置为服务。有关更多信息，请参阅“添加自托管 Runner”。

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

安装服务

  1. 如果自托管 Runner 应用程序当前正在运行，请将其停止。

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

    sudo ./svc.sh install

  3. 或者，该命令带有一个可选的 user 参数，用于以其他用户身份安装服务。

    ./svc.sh install USERNAME

安装服务

  1. 如果自托管 Runner 应用程序当前正在运行，请将其停止。

  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

有关查看自托管 Runner 状态的更多信息，请参阅“监视和排查自托管 Runner 故障”。

停止服务

使用以下命令停止服务

sudo ./svc.sh stop

Stop-Service "actions.runner.*"

./svc.sh stop

卸载服务

  1. 如果服务当前正在运行，请将其停止。

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

    sudo ./svc.sh uninstall

    Remove-Service "actions.runner.*"

    ./svc.sh uninstall

自定义自托管 Runner 服务

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

自定义自托管 Runner 服务

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