Adding self-hosted runners

You can add a self-hosted runner to a repository, an organization, or an enterprise.

If you are an organization or enterprise administrator, you might want to add your self-hosted runners at the organization or enterprise level. This approach makes the runner available to multiple repositories in your organization or enterprise, and also lets you to manage your runners in one place.

For information on supported operating systems for self-hosted runners, or using self-hosted runners with a proxy server, see "About self-hosted runners."

You can set up automation to scale the number of self-hosted runners. For more information, see "Autoscaling with self-hosted runners."

Prerequisites

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

• 詳細については、「セルフホステッド ランナーについて」を参照してください。

Adding a self-hosted runner to a repository

You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

1. On GitHub.com, navigate to the main page of the repository.

2. リポジトリ名の下の [ 設定] をクリックします。

3. In the left sidebar, click Actions, then click Runners.

4. Click New self-hosted runner.

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

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

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

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

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

   • セルフホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してください。
   • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

Checking that your self-hosted runner was successfully added

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Runners".

The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to GitHub Enterprise Cloud 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

For more information, see "Monitoring and troubleshooting self-hosted runners."

Adding a self-hosted runner to an organization

You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

1. On GitHub.com, navigate to the main page of the organization.

2. Organization 名の下で、 [設定] をクリックします。

3. In the left sidebar, click Actions, then click Runners.

4. Click New runner, then click New self-hosted runner.

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

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

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

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

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

   • セルフホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してください。
   • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

Checking that your self-hosted runner was successfully added

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Runners".

The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to GitHub Enterprise Cloud 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

For more information, see "Monitoring and troubleshooting self-hosted runners."

Adding a self-hosted runner to an enterprise

You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization admins are then able to control which repositories can use it.

New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "Managing access to self-hosted runners."

To add a self-hosted runner to an enterprise, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the enterprise endpoints in the GitHub Actions REST API.

1. GitHub.com の右上の自分のプロファイル写真をクリックし、 [自分の Enterprise] をクリックします。

2. Enterpriseのリストで、表示したいEnterpriseをクリックしてください。

3. Enterprise サイドバーで、 [ポリシー] をクリックします。

4. [ ポリシー] で、 [アクション] をクリックします。

5. [Runners](ランナー) タブをクリックします。

6. Click New runner, then click New self-hosted runner.

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

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

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

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

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

   • セルフホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトからセルフホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳細については、「セルフホスト ランナー アプリケーションをサービスとして構成する」を参照してください。
   • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

Checking that your self-hosted runner was successfully added

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Runners".

The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to GitHub Enterprise Cloud 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

For more information, see "Monitoring and troubleshooting self-hosted runners."

Making enterprise runners available to repositories

By default, runners in an enterprise's "Default" self-hosted runner group are available to all organizations in the enterprise, but are not available to all repositories in each organization.

To make an enterprise-level self-hosted runner group available to an organization repository, you might need to change the organization's inherited settings for the runner group to make the runner available to repositories in the organization.

For more information on changing runner group access settings, see "Managing access to self-hosted runners using groups."

Further reading

• "Getting started with self-hosted runners for your enterprise"