GHE.com での GitHub Connect の有効化

GitHub ConnectがGHE.comとお使いの GitHub Enterprise Server インスタンスの間でデータを共有できるようにします。

この記事で

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

** GHE.com **で企業に接続する場合:

  • サーバー統計を使用できません。
  • GitHub.com アクションは使用できません。

GitHub Connectが有効になっている場合はどうなりますか?

GitHub Connect を有効にするときに、お使いの GitHub Enterprise Server インスタンス と GitHub Enterprise Cloud の Enterprise アカウントとの間の接続を構成します。 接続には、ポート 443 または 80 経由の HTTPS が使用され、TLS によって保護されます。

GitHub Connect を有効にすると、Enterprise アカウントによって所有された GitHub App が GitHub Enterprise Cloud 上に作成されます。 GitHub Enterprise Server は GitHub App の資格情報を使って GitHub Enterprise Cloud に要求を行います。

GitHub Enterprise Server は GitHub App からの資格情報を保存します。 次の資格情報が高可用性またはクラスター環境のすべてのノードにレプリケートされ、GitHub Enterprise Server Backup Utilities によって作成されたスナップショットを含むすべてのバックアップに保存されます。

  • 1 時間にわたって有効な認証トークン
  • 新しい認証トークンを生成するのに使われる秘密キー

前提条件

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

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

  • プロキシの構成: プロキシ サーバーを使用している場合は、次の 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. インスタンスがGHE.comのGitHub Connectに接続できるようにするには、次のコマンドを実行します。 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. 構成を適用するには、次のコマンドを実行します。

    メモ

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

    Shell
    ghe-config-apply

実行が完了したら、 GitHub Connectを構成できます。

手順 2: 有効にする GitHub Connect

GitHub Connectを有効にするには、GitHub Enterprise ServerとGitHub Enterprise Cloudの両方でエンタープライズ所有者である必要があります。

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

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

  2. GitHub Enterprise Server の右上隅にあるプロフィール画像をクリックしてから、[Enterprise settings] をクリックします。

  3. ページの上部にある [ GitHub Connect] をクリックします。

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

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

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

GitHub.com への接続の再有効化

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

  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. 構成を適用するには、次のコマンドを実行します。

    メモ

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

    Shell
    ghe-config-apply

  4. GitHub ConnectでGitHub.comを有効にします。 「GitHub.com の GitHub Connect の有効化」を参照してください。