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.

Managing your GitHub Enterprise license

You can view, manage, and update your GitHub Enterprise 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 you can add to GitHub Enterprise. After you download and install GitHub Enterprise, uploading the license file unlocks the application for you to use. For more information about downloading GitHub Enterprise, see the GitHub Enterprise Releases website. For information about setting up your GitHub Enterprise Server instance, see "Setting up a GitHub Enterprise instance."

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, their primary GitHub Enterprise email address must be the same as their verified GitHub Enterprise Cloud email address. 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, contact GitHub's Sales team.

You can download your GitHub Enterprise Server license from your enterprise account. For more information, see "Managing your GitHub Enterprise license."

Downloading a new license and uploading it to GitHub Enterprise Server

After you purchase a new license or upgrade an existing license from GitHub's Sales team, you must download your new license file, 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, contact GitHub's Sales team. Your new license file will be available for download immediately after you complete your order.

  1. Navigate to GitHub.com.

  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 Server

  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 "Enterprise Server Instances", click to download your license file. Download GitHub Enterprise Server license

  7. Log into your GitHub Enterprise Server instance as a site administrator.

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

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

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

  11. Under "Quick links", click Update license. Update license link

  12. To select your license, click License file, or drag your license file onto License file. Upload license file

  13. Click Upload. Begin upload

If the web UI for GitHub Enterprise Server doesn't reflect your updated license immediately, see "Troubleshooting."

Viewing license usage

  1. Navigate to GitHub.com.

  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 Server

  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. Review your current GitHub Enterprise license, as well as consumed and available user licenses.

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

Manually syncing user license usage between GitHub Enterprise Server and 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. 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

Troubleshooting

In some scenarios, the web UI for GitHub Enterprise Server may not immediately reflect your new license. You can force the system to detect the license by restarting two system services.

  1. SSH into your GitHub Enterprise Server instance. For more information, see "Accessing the administrative shell (SSH)."

    $ ssh -p 122 admin@HOSTNAME
  2. Restart the services for Git authentication and the HTTP server.

    Warning: Running the following command will result in a few minutes of user-facing downtime for GitHub Enterprise Server. Run the command with care.

    sudo systemctl restart github-gitauth github-unicorn
    
  3. After GitHub Enterprise Server returns you to a prompt, try accessing GitHub Enterprise Server via the command line or web UI again.