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.

Who can use this feature

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.

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

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.

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 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 Enterprise Managed Users."

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

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

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

  5. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar

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

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

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

  4. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar

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

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

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

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

  10. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar

  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