ノート: GitHubホストランナーは、現在GitHub Enterprise Serverでサポートされていません。 GitHubパブリックロードマップで、計画されている将来のサポートに関する詳しい情� �を見ることができます。
リポジトリ、Organization、Enterpriseにセルフホストランナーを追� できます。
Organization または Enterprise 管理者の� �合は、Organization または Enterprise レベルでセルフホストランナーを追� することをお勧めします。 このアプローチにより、Organization または Enterprise 内の複数のリポジトリでランナーを使用できるようになり、ランナーを1か所で管理することもできます。
セルフホストランナーでサポートされているオペレーティングシステ� 、あるいはプロキシサーバーとセルフホストランナーを使う方法に関する情� �については、「セルフホストランナーについて」を参照してく� さい。
警告: セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー中でコードを実行するPull Requestを作成することによって、リポジトリのフォークが危険なコードをセルフホストランナーマシン上で実行できる可能性があるためです。
詳しい情� �については「セルフホストランナーについて」を参照してく� さい。
必要な環境
-
GitHub Actions must be enabled for GitHub Enterprise Server. A site administrator can enable and configure GitHub Actions for your instance. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."
-
You must have access to the machine you will use as a self-hosted runner in your environment.
-
The connection between self-hosted runners and GitHub Enterprise Server is over HTTP (port 80) or HTTPS (port 443). To ensure connectivity over HTTPS, configure TLS for GitHub Enterprise Serverインスタンス. For more information, see "Configuring TLS." For more information, see "About self-hosted runners."
リポジトリへのセルフホストランナーの追�
単一のリポジトリにセルフホストランナーを追� できます。 セルフホストランナーをユーザのリポジトリに追� するには、リポジトリのオーナーでなければなりません。 Organizationのリポジトリの� �合は、Organizationのオーナーであるか、そのリポジトリの管理アクセスを持っていなければなりません。 For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."
-
GitHub Enterprise Serverインスタンスで、リポジトリのメインページにアクセスしてく� さい。
-
リポジトリ名の下で Settings(設定)をクリックしてく� さい。
-
In the left sidebar, click Actions.
-
GitHub Insightsの "セルフホストランナー" で、[Add runner] をクリックします。
-
Select the operating system image and architecture of your self-hosted runner machine.
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
ノート: Windowsでは、セルフホストランナーアプリケーションをサービスとしてインストールしたいのなら、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホストランナーアプリケーションのためのディレクトリとして利用し、Windowsのシステ� アカウントがランナーディレクトリにアクセスできるようにすることをおすすめします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホストランナーアプリケーションを設定し、GitHub Actionsに登録します。config
スクリプトには、登録先のURLと、リクエストを認証してもらうための自動的に生成された時間限定のあるトークンが必要です。- Windowsでは、
config
スクリプトはセルフホストランナーをサービスとしてインストールするかも聞いてきます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳しい情� �については「サービスとしてセルフホストランナーを構成する」を参照してく� さい。
- Windowsでは、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。
セルフホストランナーの追� に成功したことの確認
After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 When the runner application is connected to GitHub Enterprise Server and ready to receive jobs, you will see the following message on the machine's terminal.
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳しい情� �については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してく� さい。
Organizationへのセルフホストランナーの追�
セルフホストランナーをOrganizationのレベルで追� し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 Organizationにセルフホストランナーを追� するには、Organizationのオーナーでなければなりません。 For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."
-
GitHub Enterprise Serverインスタンスで、Organizationのメインページにアクセスしてく� さい。
-
Organization 名の下で、クリックします Settings.
-
In the left sidebar, click Actions.
-
GitHub Insightsの "Self-hosted runners", click Add runner."
-
Select the operating system image and architecture of your self-hosted runner machine.
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
ノート: Windowsでは、セルフホストランナーアプリケーションをサービスとしてインストールしたいのなら、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホストランナーアプリケーションのためのディレクトリとして利用し、Windowsのシステ� アカウントがランナーディレクトリにアクセスできるようにすることをおすすめします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホストランナーアプリケーションを設定し、GitHub Actionsに登録します。config
スクリプトには、登録先のURLと、リクエストを認証してもらうための自動的に生成された時間限定のあるトークンが必要です。- Windowsでは、
config
スクリプトはセルフホストランナーをサービスとしてインストールするかも聞いてきます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳しい情� �については「サービスとしてセルフホストランナーを構成する」を参照してく� さい。
- Windowsでは、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。
セルフホストランナーの追� に成功したことの確認
After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 When the runner application is connected to GitHub Enterprise Server and ready to receive jobs, you will see the following message on the machine's terminal.
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳しい情� �については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してく� さい。
ノート: セキュリティ上の理由から、デフォルトではパブリックリポジトリはランナーグループ内のランナーを使うことはできません。しかし、これはランナーグループの設定で上書きできます。 詳しい情� �については、「グループを使用したセルフホストランナーへのアクセスの管理」を参照してく� さい。
セルフホストランナーを Enterprise に追� する
You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. Organization の管理者は、そのランナーを使用できるリポジトリを制御できます。
新しいランナーがデフォルトグループに割り当てられます。 ランナーを登録した後、ランナーのグループを変更できます。 詳しい情� �については、「セルフホストランナーへのアクセスを管理する」を参照してく� さい。
To add a self-hosted runner to an enterprise, you must be an enterprise owner.
-
GitHub Enterprise Serverの右上で、プロフィール写真をクリックし、続いてEnterprise settings(Enterpriseの設定)をクリックしてく� さい。
-
Enterpriseアカウントのサイドバーで、 Policies(ポリシー)をクリックしてく� さい。
-
Under " Policies", click Actions.
-
Self-hosted runners(セルフホストランナー)タブをクリックしてく� さい。
-
[Add new] をクリックし、[New runner] をクリックします。
-
Select the operating system image and architecture of your self-hosted runner machine.
-
ランナーアプリケーションをダウンロードして、使用するセルフホストランナーのマシンにインストールする方法が表示されます。
セルフホストランナーのマシンでシェルを開き、表示� �に従ってシェルコマンドを実行してく� さい。
ノート: Windowsでは、セルフホストランナーアプリケーションをサービスとしてインストールしたいのなら、シェルを管理者権限でオープンしなければなりません。 また、
C:\actions-runner
をセルフホストランナーアプリケーションのためのディレクトリとして利用し、Windowsのシステ� アカウントがランナーディレクトリにアクセスできるようにすることをおすすめします。この指示に従えば、以下のタスクが完了します。
- セルフホストランナーアプリケーションのダウンロードと展開。
config
スクリプトを実行してセルフホストランナーアプリケーションを設定し、GitHub Actionsに登録します。config
スクリプトには、登録先のURLと、リクエストを認証してもらうための自動的に生成された時間限定のあるトークンが必要です。- Windowsでは、
config
スクリプトはセルフホストランナーをサービスとしてインストールするかも聞いてきます。 LinuxとmacOSでは、ランナーの追� を終えた後にサービスをインストールできます。 詳しい情� �については「サービスとしてセルフホストランナーを構成する」を参照してく� さい。
- Windowsでは、
- セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。
セルフホストランナーの追� に成功したことの確認
After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".
ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 When the runner application is connected to GitHub Enterprise Server and ready to receive jobs, you will see the following message on the machine's terminal.
√ Connected to GitHub
2019-10-24 05:45:56Z: Listening for Jobs
詳しい情� �については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してく� さい。
ノート: セキュリティ上の理由から、デフォルトではパブリックリポジトリはランナーグループ内のランナーを使うことはできません。しかし、これはランナーグループの設定で上書きできます。 詳しい情� �については、「グループを使用したセルフホストランナーへのアクセスの管理」を参照してく� さい。
Enterprise ランナーをリポジトリで利用可能にする
デフォルトでは、Enterprise の「デフォルト」のセルフホストランナーグループのランナーは、Enterprise 内のすべての Organization で使用できますが、各 Organization のすべてのリポジトリで使用できるわけではありません。
Enterprise レベルのセルフホストランナーグループを Organization リポジトリで使用できるようにするには、ランナーグループの Organization の継承設定を変更して、Organization 内のリポジトリでランナーを使用できるようにする必要がある� �合があります。
ランナーグループのアクセス設定の変更に関する詳しい情� �については、「グループを使用したセルフホストランナーへのアクセスを管理する」を参照してく� さい。