English

Explore by product

Billing and payments
English

This version of GitHub Enterprise was discontinued on 2021-06-09. 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.

Article version: Enterprise Server 2.21
Article version: Enterprise Server 2.21

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.

In this article

About synchronization of license usage

You can allocate the user count for your GitHub Enterprise license to members of both your GitHub Enterprise Server instance and an enterprise account on GitHub Enterprise Cloud. When you add a user to either environment, the user will consume one license. If a user has accounts in both environments, to consume only one license, the user's primary email address on your GitHub Enterprise Server instance must be the same as the user's verified email address on GitHub.com. You can sync license count and usage between the environments.

If you allow your GitHub Enterprise Server instance to connect to GitHub.com, you can sync license usage between your enterprise accounts automatically. Automatic synchronization ensures that you see up-to-date license details on GitHub.com. If you don't want to allow your GitHub Enterprise Server instance to connect to GitHub.com, you can manually sync license usage by uploading a file from your GitHub Enterprise Server instance to GitHub.com.

For more information about licenses and usage for GitHub Enterprise Server, see "About licenses for GitHub Enterprise."

Automatically syncing license usage

You can use GitHub Connect to automatically sync user license count and usage between GitHub Enterprise Server and GitHub Enterprise Cloud. For more information, see "Enabling automatic user license sync between GitHub Enterprise Server and GitHub Enterprise Cloud."

Manually syncing 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. Navigate to your enterprise account by visiting https://HOSTNAME/enterprises/ENTERPRISE-NAME, replacing HOSTNAME with your instance's hostname and ENTERPRISE-NAME with your enterprise account's name.

  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 Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar

  10. In the left sidebar, click License. "License" 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