Skip to main content

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

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

注: セルフホスト ランナー アプリケーションをサービスとして設定する前に、ランナーを GitHub AE に追加する必要があります。 詳細については、「セルフホストランナーの追加」を参照してください。

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

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

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

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

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

注: セルフホスト ランナー アプリケーションをサービスとして設定する前に、ランナーを GitHub AE に追加する必要があります。 詳細については、「セルフホストランナーの追加」を参照してください。

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

サービスのインストール

  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 サービス構成を使わない場合は、カスタマイズされたサービスを作成するか、好みのサービスの仕組みを使うことができます。 参照としてテンプレート servicedactions-runner/bin/actions.runner.service.template で使用することを検討してください。 カスタマイズされたサービスを使う場合、セルフホステッド ランナー サービスは常に runsvc.sh エントリ ポイントを使って起動する必要があります。

セルフホストランナーサービスのカスタマイズ

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