Skip to main content

自己ホストランナーの追加

リポジトリ、Organization、Enterpriseにセルフホストランナーを追加できます。

リポジトリ、Organization、Enterpriseにセルフホストランナーを追加できます。

Organization または Enterprise 管理者の場合は、Organization または Enterprise レベルでセルフホストランナーを追加することをお勧めします。 このアプローチにより、Organization または Enterprise 内の複数のリポジトリでランナーを使用できるようになり、ランナーを1か所で管理することもできます。

セルフホステッド ランナーでサポートされているオペレーティング システム、またはプロキシ サーバーでセルフホステッド ランナーを使う方法については、「セルフホステッド ランナーの概要」をご覧ください。

警告: セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー内でコードを実行する pull request を作成することで、パブリック リポジトリのフォークによって、セルフホステッド ランナー マシン上で危険なコードが実行される可能性があるからです。

詳しくは、「セルフホステッド ランナーの概要」を参照してください。

セルフホステッド ランナーの数をスケーリングするように自動化を設定できます。 詳しくは、「セルフホステッド ランナーによる自動スケーリング」を参照してください。

Just-In-Time ランナーの登録を使って、登録がクリーンアップされる前に 1 つのジョブを実行するエフェメラル ランナーを登録できます。 詳しくは、「GitHub Actions のセキュリティ強化」を参照してください。

前提条件

  • 環境内でセルフホステッド ランナーとして使用するマシンにアクセスできる必要があります。

リポジトリへのセルフホストランナーの追加

単一のリポジトリにセルフホストランナーを追加できます。 セルフホストランナーをユーザのリポジトリに追加するには、リポジトリのオーナーでなければなりません。 組織リポジトリの場合、組織の所有者であるか、リポジトリへの管理者アクセス権を持っている必要があります。

REST API を使ってセルフホスト ランナーを追加する方法については、「セルフホステッド ランナーの REST API エンドポイント」をご覧ください。

: Organization の所有者は、リポジトリ レベルのセルフホステッド ランナーの作成を許可するリポジトリを選択できます。 。

詳細については、「Organization について GitHub Actions を無効化または制限する」を参照してください。

  1. GitHub.com で、リポジトリのメイン ページへ移動します。

  2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. 左のサイドバーで [アクション] をクリックしてから、 [ランナー] をクリックします。

  4. [新規フホスト ランナー] をクリックします。

  5. 使用するセルフホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

    オペレーティング システムとアーキテクチャの選択のスクリーンショット。 これらのオプションは、濃いオレンジ色の枠線で強調表示されています。

  6. ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。

    セルフホストランナーのマシンでシェルを開き、表示順に従ってシェルコマンドを実行してください。

    注: Windows で、セルフホスト ランナー アプリケーションをサービスとしてインストールする場合は、シェルを管理者権限でオープンしなければなりません。 また、C:\actions-runner をセルフホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステム アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。

    この指示に従えば、以下のタスクが完了します。

    • セルフホストランナーアプリケーションのダウンロードと展開。
    • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
    • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

セルフホストランナーの追加に成功したことの確認

セルフホステッド ランナーを追加する手順を完了すると、ランナーとその状態が "ランナー" の下に表示されます。

ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

詳しくは、「セルフホストランナーのモニタリングとトラブルシューティング」を参照してください。

Organizationへのセルフホストランナーの追加

セルフホストランナーをOrganizationのレベルで追加し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 セルフ ホスト ランナーを組織に追加するには、組織の所有者。 REST API を使ってセルフホスト ランナーを追加する方法については、「セルフホステッド ランナーの REST API エンドポイント」をご覧ください。

  1. GitHub.com で、Organization のメイン ページへ移動します。

  2. 組織名の下で、 [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    組織のプロファイルのタブのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で囲まれています。

  3. 左のサイドバーで [アクション] をクリックしてから、 [ランナー] をクリックします。

  4. [新しいランナー] をクリックし、 [新しいセルフホステッド ランナー] をクリックします。 1. 使用するセルフホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

    オペレーティング システムとアーキテクチャの選択のスクリーンショット。 これらのオプションは、濃いオレンジ色の枠線で強調表示されています。

  5. ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。

    セルフホストランナーのマシンでシェルを開き、表示順に従ってシェルコマンドを実行してください。

    注: Windows で、セルフホスト ランナー アプリケーションをサービスとしてインストールする場合は、シェルを管理者権限でオープンしなければなりません。 また、C:\actions-runner をセルフホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステム アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。

    この指示に従えば、以下のタスクが完了します。

    • セルフホストランナーアプリケーションのダウンロードと展開。
    • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
    • セルフホストランナー��プリケーションを実行して、マシンをGitHub Actionsに接続します。

セルフホストランナーの追加に成功したことの確認

セルフホステッド ランナーを追加する手順を完了すると、ランナーとその状態が "ランナー" の下に表示されます。

ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

詳しくは、「セルフホストランナーのモニタリングとトラブルシューティング」を参照してください。

注: セキュリティ上の理由により、既定で、パブリック リポジトリでは、ランナー グループ内でランナーを使用することができませんが、ランナー グループの設定でこれをオーバーライドすることができます。 詳しくは、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してください。

セルフホストランナーを Enterprise に追加する

GitHub Enterprise Cloud を使用する場合、セルフホスト ランナーを Enterprise に追加できます。この場合、複数の組織に割り当てることができます。 組織のオーナーは、どのリポジトリがそれを使用できるかをコントロールできます。 詳しくは、GitHub Enterprise Cloud のドキュメントをご覧ください。