Skip to main content

Enabling automatic user license sync for your enterprise

You can manage license usage across your GitHub Enterprise environments by automatically syncing user licenses from your GitHub Enterprise Server instance to GitHub Enterprise Cloud.

Enterprise owners can enable automatic user license synchronization.

About automatic license synchronization

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" in the GitHub Enterprise Cloud documentation.

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. For more information, see "About GitHub Connect."

If you enable automatic user license sync for your enterprise, GitHub Connect will automatically synchronize license usage between GitHub Enterprise Server and GitHub Enterprise Cloud weekly. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see "Triggering a license sync job."

If you use multiple GitHub Enterprise Server instances, you can enable automatic license sync between each of your instances and the same organization or enterprise account on 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."

You can also manually upload GitHub Enterprise Server user license information to GitHub Enterprise Cloud. For more information, see "Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud."

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" in the GitHub Enterprise Cloud documentation.

Enabling license synchronization

Before enabling license synchronization on your GitHub Enterprise Server instance, you must enable GitHub Connect. For more information, see "Managing GitHub Connect."

  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 GitHub Connect. GitHub Connect tab in the enterprise account sidebar

  3. Under "Server can sync user license count and usage", use the drop-down menu and select Enabled. Drop-down menu to enable automatic user license sync