自己ホストランナーアプリケーションをサービスとして設定する

自己ホストランナーアプリケーションをサービスとして設定し、マシンの起動時に自動的にランナーアプリケーションが開始されるようにできます。

Platform navigation

この記事の内容

Note

自己ホストランナー アプリケーションをサービスとして構成する前に、ランナーを GitHub に追加する必要があります。 詳しくは、「自己ホストランナーの追加」を参照してください。

systemd を使用している Linux システムの場合、ランナーを正常に追加した後に作成される svc.sh スクリプトを使用して、アプリケーションをサービスとして使用して、インストールおよび管理することができます。

ランナー マシンで、自己ホスト ランナー アプリケーションをインストールしたディレクトリでシェルを開きます。 以下のコマンドを使って、自己ホスト ランナー サービスをインストールおよび管理します。

Note

Windows 上でサービスとして自己ホストランナー アプリケーションを構成するのは、アプリケーション構成プロセスの一部です。 自己ホストランナーアプリケーションをすでに設定していて、サービスとして設定していない場合には、そのランナーをGitHubから削除して、アプリケーションを設定しなおさなければなりません。 アプリケーションを再設定する場合には、アプリケーションをサービスとして設定するオプションを選択してください。

詳細については、「セルフホストランナーの削除」および「自己ホストランナーの追加」を参照してください。

ランナー サービスは、Windows サービス アプリケーションで管理することも、PowerShell を使用して次のコマンドを実行することもできます。

Note

自己ホストランナー アプリケーションをサービスとして構成する前に、ランナーを GitHub に追加する必要があります。 詳しくは、「自己ホストランナーの追加」を参照してください。

ランナー マシンで、自己ホスト ランナー アプリケーションをインストールしたディレクトリでシェルを開きます。 以下のコマンドを使って、自己ホスト ランナー サービスをインストールおよび管理します。

サービスのインストール

  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

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

</div>

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

</div>

自己ホストランナーサービスのカスタマイズ

上記の既定の systemd サービス構成を使わない場合は、カスタマイズされたサービスを作成するか、好みのサービスの仕組みを使うことができます。 参照としてテンプレート serviced を actions-runner/bin/actions.runner.service.template で使用することを検討してください。 カスタマイズされたサービスを使う場合、自己ホスト ランナー サービスは常に runsvc.sh エントリ ポイントを使って起動する必要があります。

自己ホストランナーサービスのカスタマイズ

上記のデフォルトのlaunchdサービス設定を使いたくないなら、カスタマイズされたサービスを作成するか、好みのサービスの仕組みを使うことができます。 参照としてテンプレート plist を actions-runner/bin/actions.runner.plist.template で使用することを検討してください。 カスタマイズされたサービスを使う場合、自己ホスト ランナー サービスは常に runsvc.sh エントリ ポイントを使って起動する必要があります。