Skip to main content

This version of GitHub Enterprise will be discontinued on 2022-06-03. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

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 Enterprise uses a unique-user licensing model, where each person only consumes one license, no matter how many GitHub Enterprise Server instances the person uses, or how many organizations the person is a member of on GitHub Enterprise Cloud. This model allows each person to use multiple GitHub Enterprise environments 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 personal accounts. Multiple personal 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" in the GitHub Enterprise Cloud documentation.

When you synchronize license usage, only the user ID and email addresses for each personal 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."

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 Enterprise Managed Users, 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 personal 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 Enterprise Managed Users" 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. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. In the left sidebar, click License. "License" tab in the enterprise account settings sidebar

  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. Navigate to GitHub.com.

  6. In the top-right corner of GitHub.com, click your profile photo, then click Your enterprises. "Your enterprises" in drop-down menu for profile photo on GitHub Enterprise Server

  7. In the list of enterprises, click the enterprise you want to view. Name of an enterprise in list of your enterprises

  8. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  9. In the left sidebar, click License. "License" tab in the enterprise account settings sidebar

  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