Skip to main content

Managing GitHub Connect

You can enable GitHub Connect to access additional features and workflows for GitHub Enterprise Server 인스턴스.

About GitHub Connect

You can access additional features and workflows on GitHub Enterprise Server 인스턴스 by enabling GitHub Connect. For more information, see "About 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

Prerequisites

To use GitHub Connect, you must have an enterprise account on GitHub.com that uses GitHub Enterprise Cloud. You may already have GitHub Enterprise Cloud included in your plan.

Note: Your enterprise account on GitHub.com must be invoiced. Enterprise accounts on the free trial of GitHub Enterprise Cloud or that pay by credit card cannot be connected to GitHub Enterprise Server 인스턴스.

If your enterprise account on GitHub.com uses IP allow lists, you must add the IP address or network for GitHub Enterprise Server 인스턴스 to your IP allow list on GitHub.com. For more information, see "Enforcing policies for security settings in your enterprise" in the GitHub Enterprise Cloud documentation.

To configure a connection, your proxy configuration must allow connectivity to github.com, api.github.com, and uploads.github.com. For more information, see "Configuring an outbound web proxy server."

Enabling GitHub Connect

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

  1. Sign in to GitHub Enterprise Server 인스턴스 and GitHub.com.

  2. GitHub Enterprise Server의 오른쪽 위 모서리에서 프로필 사진과 엔터프라이즈 설정을 차례로 클릭합니다.

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

  3. 엔터프라이즈 계정 사이드바에서 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.

Disabling GitHub Connect

Enterprise owners can disable GitHub Connect.

When you disconnect from GitHub Enterprise Cloud, the GitHub Connect GitHub App is deleted from your enterprise account and credentials stored on GitHub Enterprise Server 인스턴스 are deleted.

  1. GitHub Enterprise Server의 오른쪽 위 모서리에서 프로필 사진과 엔터프라이즈 설정을 차례로 클릭합니다.

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

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

  3. Under "GitHub Connect", to the right of the enterprise account you'd like to disconnect, click Disable GitHub Connect.

  4. Read the information about disconnection, then click Disable GitHub Connect.