GHE.com での GitHub Connect の有効化

GitHub Connect を有効にすると、お使いの GitHub Enterprise Server インスタンスの追加の機能とワークフローにアクセスできます。 「GitHub Connect について」を参照してください。

GHE.com では、GitHub Connect 機能に、リソースを GitHub.com に依存する機能は含まれていません。

GitHub Connect を有効にするとどうなるか

When you enable GitHub Connect, you configure a connection between お使いの GitHub Enterprise Server インスタンス and an enterprise account on GitHub Enterprise Cloud. 接続には、ポート 443 または 80 経由の HTTPS が使用され、TLS によって保護されます。

Enabling GitHub Connect creates a GitHub App owned by the enterprise account on GitHub Enterprise Cloud. GitHub Enterprise Server uses the GitHub App's credentials to make requests to GitHub Enterprise Cloud.

GitHub Enterprise Server stores credentials from the GitHub App. The following credentials will be replicated to all nodes in a high availability or cluster environment, and stored in any backups, including snapshots created by GitHub Enterprise Server Backup Utilities.

• An authentication token, which is valid for one hour
• A private key, which is used to generate a new authentication token

前提条件

• 管理アクセス: GHE.com と GitHub Enterprise Server インスタンスの両方の Enterprise アカウントに対する管理アクセス権が必要です。

• バージョン要件: GitHub Enterprise Server インスタンスは、GitHub Enterprise Server 3.12 以降を実行する必要があります。

• プロキシ構成: プロキシ サーバーを使用している場合は、次の GHE.com ホスト名への接続を許可します (SUBDOMAIN を自社のサブドメインに置き換えます)。

  • SUBDOMAIN.ghe.com
  • api.SUBDOMAIN.ghe.com
  • uploads.SUBDOMAIN.ghe.com

  「アウトバウンドの Web プロキシ サーバーの設定」を参照してください。

ステップ 1: GHE.com への接続を有効にする

既定では、GitHub Connect は GitHub Enterprise Server を GitHub.com に接続します。 インスタンスが自社の GHE.com のサブドメインに接続できるようにする必要があります。

接続を有効にするには、お使いの GitHub Enterprise Server インスタンスへの管理 SSH アクセス権を持つユーザーが、次のタスクを完了する必要があります。

1. お使いの GitHub Enterprise Server インスタンス に SSH で接続します。 インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリ ノードに SSH 接続します。 クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。 詳しくは、「管理シェル (SSH) にアクセスする」を参照してください。

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. インスタンスが GitHub Connect の GHE.com に接続できるようにするには、次のコマンドを実行します。 SUBDOMAIN は、GHE.com 上の自社のサブドメインに置き換えます (例: octocorp)。

   Shell

   ghe-config app.github.github-connect-ghe-com-enabled true
   ghe-config app.github.github-connect-ghe-com-subdomain "SUBDOMAIN"
   

3. 構成を適用するには、次のコマンドを実行します。

   Note

   構成の実行中に、お使いの GitHub Enterprise Server インスタンス 上のサービスが再起動する可能性があり、これによりユーザーに短時間のダウンタイムが発生する場合があります。

   Shell

   ghe-config-apply
   

実行の完了後、GitHub Connect を構成できます。

ステップ 2: GitHub Connect を有効にする

GitHub Connect を有効にするには、GitHub Enterprise Server と GitHub Enterprise Cloud の両方で Enterprise 所有者になる必要があります。

両方の環境にユーザー アカウントを持つユーザーは、お使いの GitHub Enterprise Server インスタンスからアカウントに接続できます。

1. お使いの GitHub Enterprise Server インスタンスと GHE.com にサインインします。

2. GitHub Enterprise Server の右上で、ご自分のプロフィール フォトをクリックしてから、 [Enterprise 設定] をクリックします。

   

3. [Enterprise アカウント] サイドバーで、 [GitHub Connect] をクリックします。

4. [GitHub Connect はまだ有効になっていません] で、 [GitHub Connect を有効にする] をクリックします。 [GitHub Connect を有効にする] をクリックすると、「追加の製品および機能に適用される GitHub 条件」に同意したことになります。

5. 接続しようとする Enterprise アカウントの右側にある [接続] をクリックします。

6. 有効にする GitHub Connect の個々の機能を選択します。 「GitHub Connect について」を参照してください。

GitHub.com

への接続を再度有効にする

GitHub.com に対して GitHub Connect を再度有効にする必要がある場合は、設定を再構成する必要があります。

1. お使いの GitHub Enterprise Server インスタンス に SSH で接続します。 インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリ ノードに SSH 接続します。 クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。 詳しくは、「管理シェル (SSH) にアクセスする」を参照してください。

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. 次のコマンドを実行します。

   Shell

   ghe-config app.github.github-connect-ghe-com-enabled false
   

3. 構成を適用するには、次のコマンドを実行します。

   Note

   構成の実行中に、お使いの GitHub Enterprise Server インスタンス 上のサービスが再起動する可能性があり、これによりユーザーに短時間のダウンタイムが発生する場合があります。

   Shell

   ghe-config-apply
   

4. GitHub.com で GitHub Connect を有効にします。 「Enabling GitHub Connect for GitHub.com」をご覧ください。