Skip to main content

Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud

You can sync license usage from GitHub Enterprise Server to GitHub Enterprise Cloud to view all license usage across your enterprise in one place and ensure that people with accounts in both environments only consume one user license.

Enterprise owners can sync license usage between enterprise accounts on GitHub Enterprise Server and GitHub Enterprise Cloud.

About synchronization of license usage

GitHub uses a unique-user licensing model. For enterprise products that include multiple deployment options, GitHub determines how many licensed seats you're consuming based on the number of unique users across all your deployments.

Each user account only consumes one license, no matter how many GitHub Enterprise Server instances the user account uses, or how many organizations the user account is a member of on GitHub Enterprise Cloud. This model allows each person to use multiple GitHub Enterprise deployments without incurring extra costs.

For a person using multiple GitHub Enterprise environments to only consume a single license, you must synchronize license usage between environments. Then, GitHub will deduplicate users based on the email addresses associated with their user accounts. Multiple user accounts will consume a single license when there is a match between an account's primary email address on GitHub Enterprise Server and/or an account's verified email address on GitHub.com. For more information about verification of email addresses on GitHub.com, see "Verifying your email address."

When you synchronize license usage, only the user ID and email addresses for each user account on GitHub Enterprise Server are transmitted to GitHub Enterprise Cloud.

To ensure that you see up-to-date license details on GitHub.com, you can sync license usage between the environments automatically, using GitHub Connect. For more information about GitHub Connect, see "About GitHub Connect" in the GitHub Enterprise Server documentation.

If you don't want to enable GitHub Connect, you can manually sync license usage by uploading a file from GitHub Enterprise Server to GitHub.com.

After you synchronize license usage, you can see a report of consumed licenses across all your environments in the enterprise settings on GitHub.com. For more information, see "Viewing license usage for GitHub Enterprise."

Note: If you synchronize license usage and your enterprise account on GitHub.com does not use 企业托管用户, we highly recommend enabling verified domains for your enterprise account on GitHub.com. For privacy reasons, your consumed license report only includes the email address associated with a user account on GitHub.com if the address is hosted by a verified domain. If one person is erroneously consuming multiple licenses, having access to the email address that is being used for deduplication makes troubleshooting much easier. For more information, see "Verifying or approving a domain for your enterprise" and "About 企业托管用户."

Automatically syncing license usage

You can use GitHub Connect to automatically synchronize user license count and usage between GitHub Enterprise Server and GitHub Enterprise Cloud weekly. For more information, see "Enabling automatic user license sync for your enterprise" in the GitHub Enterprise Server documentation.

After you enable GitHub Connect, license data will be automatically synchronized weekly. You can also manually synchronize your license data at any time, by triggering a license sync job.

Triggering a license sync job

  1. Sign in to your GitHub Enterprise Server instance.

  2. 在 GitHub.com 的右上角,单击您的个人资料照片,然后单击 Your enterprises(您的企业)GitHub Enterprise Cloud 上个人资料照片下拉菜单中的"Your enterprises(您的企业)"

  3. 在企业列表中,单击您想要查看的企业。 企业列表中的企业名称

  4. 在企业帐户侧边栏中,单击 Settings(设置)企业帐户侧边栏中的“设置”选项卡

  5. 在左侧边栏中,单击 Enterprise licensing(企业许可)企业帐户设置侧边栏中的"Enterprise licensing(企业许可)"选项卡

  6. Under "License sync", click Sync now. Screenshot of "Sync now" button in license sync section

Manually uploading GitHub Enterprise Server license usage

You can download a JSON file from GitHub Enterprise Server and upload the file to GitHub Enterprise Cloud to manually sync user license usage between the two deployments.

  1. 在 GitHub.com 的右上角,单击您的个人资料照片,然后单击 Your enterprises(您的企业)GitHub Enterprise Cloud 上个人资料照片下拉菜单中的"Your enterprises(您的企业)"

  2. 在企业列表中,单击您想要查看的企业。 企业列表中的企业名称

  3. 在企业帐户侧边栏中,单击 Settings(设置)企业帐户侧边栏中的“设置”选项卡

  4. 在左侧边栏中,单击 Enterprise licensing(企业许可)企业帐户设置侧边栏中的"Enterprise licensing(企业许可)"选项卡

  5. Under "Quick links", to download a file containing your current license usage on GitHub Enterprise Server, click Export license usage. Export license usage link

  6. 导航至 GitHub.com。

  7. 在 GitHub.com 的右上角,单击您的个人资料照片,然后单击 Your enterprises(您的企业)GitHub Enterprise Cloud 上个人资料照片下拉菜单中的"Your enterprises(您的企业)"

  8. 在企业列表中,单击您想要查看的企业。 企业列表中的企业名称

  9. 在企业帐户侧边栏中,单击 Settings(设置)企业帐户侧边栏中的“设置”选项卡

  10. 在左侧边栏中,单击 Enterprise licensing(企业许可)企业帐户设置侧边栏中的"Enterprise licensing(企业许可)"选项卡

  11. Under "Enterprise Server Instances", click Add server usage. Upload GitHub Enterprise Servers usage link

  12. Upload the JSON file you downloaded from GitHub Enterprise Server. Drag and drop or select a file to upload