Skip to main content

Enabling GitHub Connect for GHE.com

Enable GitHub Connect to share data between GHE.com and GitHub Enterprise Server 인스턴스.

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 "아웃바운드 웹 프록시 서버 구성."

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. 에 SSH합니다. 인스턴스가 여러 노드로 구성된 경우(예: 고가용성 또는 지역 복제가 구성된 경우) 주 노드에 대한 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의 오른쪽 위 모서리에서 프로필 사진과 엔터프라이즈 설정을 차례로 클릭합니다.

    GitHub Enterprise Server에서 프로필 사진 클릭할 때 나타나는 드롭다운 메뉴의 스크린샷 "엔터프라이즈 설정" 옵션이 진한 주황색 윤곽선으로 강조 표시됩니다.

  3. 엔터프라이즈 계정 사이드바에서 GitHub Connect 을(를) 클릭합니다.

  4. “GitHub Connect이 아직 사용하도록 설정되지 않음”에서 GitHub Connect 사용을 클릭합니다. GitHub Connect 활성화를 클릭하여 "GitHub 추가 제품 및 기능 약관"에 동의합니다.

  5. 연결하려는 엔터프라이즈 계정 오른쪽에서 연결을 클릭합니다.

  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. 에 SSH합니다. 인스턴스가 여러 노드로 구성된 경우(예: 고가용성 또는 지역 복제가 구성된 경우) 주 노드에 대한 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."