Article version: Enterprise Server 2.18

Managing your GitHub Enterprise Server license

You can download or update your GitHub Enterprise Server license.

In this article

About GitHub Enterprise licenses

When you purchase or renew GitHub Enterprise, you receive a license file to validate your application. A license file has an expiration date and controls the number of user licenses that you can add to GitHub Enterprise. After you download and install GitHub Enterprise, uploading the license file unlocks the application for you to use.

You can allocate the user licenses included in your GitHub Enterprise license to users in your GitHub Enterprise Server instance and a GitHub Enterprise Cloud enterprise account. When you add a user to either environment, they will consume a license. If a user has accounts in both environments, to consume only one license, they must use the same primary email address in both accounts. You can sync license count and usage between the environments.

If your GitHub Enterprise Server license expires, you won't be able to access your GitHub Enterprise Server instance via a web browser or Git. If needed, you will be able to use command-line utilities to back up all your data. For more information, see "Configuring backups on your appliance." If you have any questions about renewing your license, please contact our sales and account management team.

Uploading a new license to GitHub Enterprise Server

After you purchase a new license or upgrade an existing license, you must download your new license file and then upload the file to GitHub Enterprise Server to unlock your new user licenses.

If you'd like to renew or add user licenses to GitHub Enterprise, please contact our sales and account management team. Your new license file will be available for download immediately after you complete your order.

  1. Sign in to the GitHub Enterprise web portal.

  2. Open the download page.

  3. Click Download license.

    Download license

  4. Return to GitHub Enterprise Server.

  5. In the upper-right corner of any page, click .

    Rocketship icon for accessing site admin settings

  6. In the left sidebar, click Enterprise.

    Enterprise tab in the Site admin settings

  7. In the enterprise account sidebar, click Settings.

    Settings tab in the enterprise account sidebar

  8. In the left sidebar, click License.

    License tab in the enterprise settings sidebar

  9. Under "Quick links", click Update license.

    Update license link

  10. To select your license, click License file, or drag your license from your local filesystem onto License file.

    Upload license file

  11. Click Upload.

    Begin upgrade

If you have any questions, please contact our sales and account management team.

Viewing license usage

  1. In the upper-right corner of any page, click .

    Rocketship icon for accessing site admin settings

  2. In the left sidebar, click Enterprise.

    Enterprise tab in the Site admin settings

  3. In the enterprise account sidebar, click Settings.

    Settings tab in the enterprise account sidebar

  4. In the left sidebar, click License.

    License tab in the enterprise settings sidebar

  5. Review your current GitHub Enterprise license and expiration date as well as consumed and available user licenses.

Manually syncing user license usage with GitHub Enterprise Cloud

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 upper-right corner of any page, click .

    Rocketship icon for accessing site admin settings

  2. In the left sidebar, click Enterprise.

    Enterprise tab in the Site admin settings

  3. In the enterprise account sidebar, click Settings.

    Settings tab in the enterprise account sidebar

  4. In the left sidebar, click License.

    License tab in the enterprise 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 Enterprise Cloud.

  7. Navigate to your enterprise account by visiting https://github.com/enterprises/ENTERPRISE-NAME, replacing ENTERPRISE-NAME with your enterprise account's name.

  8. In the enterprise account sidebar, click Settings.

    Settings tab in the enterprise account sidebar

  9. In the left sidebar, click Billing.

    Billing tab in the enterprise account settings sidebar

  10. Under "User licenses", click Upload GitHub Enterprise 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

Automatically syncing user license usage with GitHub Enterprise Cloud

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

Ask a human

Can't find what you're looking for?

Contact us