注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
リポジトリ、Organization、Enterpriseにセルフホストランナーを追� できます。
Organization または Enterprise 管理者の� �合は、Organization または Enterprise レベルでセルフホストランナーを追� することをお勧めします。 このアプローチにより、Organization または Enterprise 内の複数のリポジトリでランナーを使用できるようになり、ランナーを1か所で管理することもできます。
セルフホステッド ランナーでサポートされているオペレーティング システ� 、またはプロキシ サーバーでセルフホステッド ランナーを使用する方法については、「セルフホステッド ランナーについて」を参照してく� さい。
警告: セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー内でコードを実行する pull request を作成することで、パブリック リポジトリのフォークによって、セルフホステッド ランナー マシン上で危険なコードが実行される可能性があるからです。
詳細については、セルフホステッド ランナーに関する記述をご覧く� さい。
セルフホステッド ランナーの数をスケーリングするように自動化を設定できます。 詳細については、「セルフホスト ランナーによる自動スケーリング」を参照してく� さい。
前提条件
-
GitHub Actions は、GitHub Enterprise Server に対して有効にする必要があります。 サイト管理者は、インスタンスの GitHub Actions を有効にして構成できます。 詳細については、「GitHub Enterprise Server の GitHub Actions の概要」を参照してく� さい。
-
環境内でセルフホステッド ランナーとして使用するマシンにアクセスできる必要があります。
-
セルフホステッド ランナーと GitHub Enterprise Server の接続は、HTTP (ポート 80) または HTTPS (ポート 443) を経由します。 HTTPS 経由で確実に接続を行うには、 に対して TLS を構成します。 詳細については、「TLS の構成」を参照してく� さい。 詳細については、「セルフホステッド ランナーについて」を参照してく� さい。
リポジトリへのセルフホストランナーの追�
単一のリポジトリにセルフホストランナーを追� できます。 セルフホストランナーをユーザのリポジトリに追� するには、リポジトリのオーナーでなければなりません。 Organizationのリポジトリの� �合は、Organizationのオーナーであるか、そのリポジトリの管理アクセスを持っていなければなりません。 REST API を使用してセルフホスト ランナーを追� する方法については、「セルフホスト ランナー」を参照してく� さい。
-
で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [ 設定] をクリックします。 1. 左側のサイドバーで、 [アクション] をクリックします。
-
左側のサイドバーの [アクション] で、 [ランナー] をクリックします。
-
[ランナー] で [ランナーの追� ] をクリックします。
-
使用するセルフホスト ランナー マシンのオペレーティング システ� イメージとアーキテクチャを選択します。
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
注: Windows で、セルフホスト ランナー アプリケーションをサービスとしてインストールする� �合は、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステ� アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。config
スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。- Windows では、
config
スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してく� さい。
- Windows では、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。 ### セルフホストランナーの追� に成功したことの確認
セルフホステッド ランナーを追� する手� �を完了すると、ランナーとその状態が の下に表示されます。
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Server に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してく� さい。
Organizationへのセルフホストランナーの追�
セルフホストランナーをOrganizationのレベルで追� し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 Organizationにセルフホストランナーを追� するには、Organizationのオーナーでなければなりません。 REST API を使用してセルフホスト ランナーを追� する方法については、「セルフホスト ランナー」を参照してく� さい。
-
で、Organization のメイン ページへ移動します。 1. Organization 名の下で、 [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] をクリックします。
-
左側のサイドバーの [アクション] で、 [ランナー] をクリックします。
-
[ランナー] で [新規追� ] をクリックしてから、 [新しいランナー] をクリックします。 1. 使用するセルフホスト ランナー マシンのオペレーティング システ� イメージとアーキテクチャを選択します。
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
注: Windows で、セルフホスト ランナー アプリケーションをサービスとしてインストールする� �合は、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステ� アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。config
スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。- Windows では、
config
スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してく� さい。
- Windows では、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。 ### セルフホストランナーの追� に成功したことの確認
セルフホステッド ランナーを追� する手� �を完了すると、ランナーとその状態が の下に表示されます。
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Server に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してく� さい。
注: セキュリティ上の理由により、既定で、パブリック リポジトリでは、ランナー グループ内でランナーを使用することができませんが、ランナー グループの設定でこれをオーバーライドすることができます。 詳細については、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してく� さい。
セルフホストランナーを Enterprise に追� する
セルフホスト ランナーを Enterprise に追� できます。この� �合、複数の組織に割り当てることができます。 Organization の管理者は、そのランナーを使用できるリポジトリを制御できます。
新しいランナーが既定のグループに割り当てられます。 ランナーを登録した後、ランナーのグループを変更できます。 詳細については、セルフホスト ランナーへのアクセスの管理に関するページを参照してく� さい。
Enterprise にセルフホステッド ランナーを追� するには、Enterprise 所有者である必要があります。
-
GitHub Enterprise Server の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 1. Enterprise サイドバーで、 [ポリシー] をクリックします。 1. [ ポリシー] で、 [アクション] をクリックします。 1. [Runners](ランナー) タブをクリックします。
-
[新規追� ] をクリックし、 [New runner](新しいランナー) をクリックします。
-
使用するセルフホスト ランナー マシンのオペレーティング システ� イメージとアーキテクチャを選択します。
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
注: Windows で、セルフホスト ランナー アプリケーションをサービスとしてインストールする� �合は、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステ� アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。config
スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。- Windows では、
config
スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してく� さい。
- Windows では、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。
セルフホストランナーの追� に成功したことの確認
セルフホステッド ランナーを追� する手� �を完了すると、ランナーとその状態が の下に表示されます。
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Server に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してく� さい。
注: セキュリティ上の理由により、既定で、パブリック リポジトリでは、ランナー グループ内でランナーを使用することができませんが、ランナー グループの設定でこれをオーバーライドすることができます。 詳細については、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してく� さい。
Enterprise ランナーをリポジトリで利用可能にする
デフォルトでは、Enterprise の「デフォルト」のセルフホストランナーグループのランナーは、Enterprise 内のすべての Organization で使用できますが、各 Organization のすべてのリポジトリで使用できるわけではありません。
Enterprise レベルのセルフホストランナーグループを Organization リポジトリで使用できるようにするには、ランナーグループの Organization の継承設定を変更して、Organization 内のリポジトリでランナーを使用できるようにする必要がある� �合があります。
ランナー グループのアクセス設定の変更について詳しくは、「グループを使用してセルフホスト ランナーへのアクセスを管理する」を参照してく� さい。