Enabling GitHub Connect for GHE.com

You can access additional features and workflows on お使いの GitHub Enterprise Server インスタンス by enabling GitHub Connect. See "GitHub Connect について."

On GHE.com, GitHub Connect features do not include any functionality that relies on resources on GitHub.com.

What happens when GitHub Connect is enabled?

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

Prerequisites

• Administrative access: You need administrative access to both an enterprise account on GHE.com and a GitHub Enterprise Server instance.

• Version requirement: Your GitHub Enterprise Server instance must run GitHub Enterprise Server 3.12 or later.

• Proxy configuration: If using a proxy server, allow connectivity to the following GHE.com hostnames (replace SUBDOMAIN with your enterprise's subdomain).

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

  See "アウトバウンドの Web プロキシ サーバーの設定."

Step 1: Enable connection to GHE.com

By default, GitHub Connect connects GitHub Enterprise Server to GitHub.com. You must enable your instance to connect to your enterprise's subdomain of GHE.com.

To enable the connection, someone with administrative SSH access to お使いの GitHub Enterprise Server インスタンス must complete the following tasks.

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

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. To enable your instance to connect to GHE.com for GitHub Connect, run the following command. Replace SUBDOMAIN with the subdomain for your enterprise on GHE.com, for example octocorp.

   Shell

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

3. To apply the configuration, run the following command.

   Note

   During a configuration run, services on お使いの GitHub Enterprise Server インスタンス may restart, which can cause brief downtime for users.

   Shell

   ghe-config-apply
   

After the run completes, you can configure GitHub Connect.

Step 2: Enable GitHub Connect

To enable GitHub Connect, you must be an enterprise owner on both GitHub Enterprise Server and GitHub Enterprise Cloud.

People with a user account in both environments can connect the accounts from お使いの GitHub Enterprise Server インスタンス.

1. Sign in to お使いの GitHub Enterprise Server インスタンス and GHE.com.

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

   

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

4. Under "GitHub Connect is not enabled yet", click Enable GitHub Connect. By clicking Enable GitHub Connect, you agree to the "追加の製品および機能に適用される GitHub 条件."

5. To the right of the enterprise account you'd like to connect, click Connect.

6. Choose which individual features of GitHub Connect you want to enable. See "GitHub Connect について."

Reenabling connections to GitHub.com

If you need to reenable GitHub Connect for GitHub.com, you must reconfigure your settings.

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

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. Run the following command.

   Shell

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

3. To apply the configuration, run the following command.

   Note

   During a configuration run, services on お使いの GitHub Enterprise Server インスタンス may restart, which can cause brief downtime for users.

   Shell

   ghe-config-apply
   

4. Enable GitHub Connect on GitHub.com. See "Enabling GitHub Connect for GitHub.com."