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 only consumes one license, no matter how many GitHub Enterprise Server instances the user uses, or how many organizations the user is a member of on GitHub Enterprise Cloud. This model allows each person to use multiple GitHub Enterprise deployments without incurring extra costs.

对于使用多个 GitHub Enterprise 环境以仅使用单个许可证的用户,您必须在环境之间同步许可证使用情况。 然后,GitHub 将根据与其用户帐户关联的电子邮件地址对用户进行重复数据删除。 For more information, see "Troubleshooting license usage for GitHub Enterprise."

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."

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.

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.

同步许可证使用情况后,您可以在 GitHub.com 上的企业设置中看到所有环境中已使用许可证的报告。 更多信息请参阅“查看 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 企业托管用户" in the GitHub Enterprise Cloud documentation.

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."

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 Enterprise Server 的右上角,单击您的个人资料照片,然后单击 Enterprise settings(Enterprise 设置)GitHub Enterprise Server 上个人资料照片下拉菜单中的"Enterprise settings(企业设置)"

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

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

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

  5. 导航至 GitHub.com。

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

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

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

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

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

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