Uploading a new license to GitHub Enterprise Server

You can upload your license file for GitHub Enterprise to your GitHub Enterprise Server instance to validate your application.

In this article

About license files for GitHub Enterprise Server

When you purchase or download a new license for GitHub Enterprise Server you must upload the new license file to GitHub Enterprise Server to unlock your new user licenses.

If you use GitHub Enterprise Cloud, you can download a license from your enterprise. For more information, see Combined GitHub Enterprise cloud and server use and Downloading your license for GitHub Enterprise.

If you'd like to renew or add user licenses to GitHub Enterprise, or if you have questions about your license, contact GitHub's Sales team. Your new license file will be available for download immediately after you complete your order.

Uploading your license from the Management Console

  1. Sign into GitHub Enterprise Server as a site administrator.

  2. In the top-right corner of GitHub Enterprise Server, click your profile picture, then click Enterprise settings.

    Screenshot of the dropdown menu shown when you click your profile picture on GitHub Enterprise Server. The "Enterprise settings" option is outlined.

  3. At the top of the page, click Settings.

  4. Under Settings, click License.

  5. In the "User licenses" section, under "Quick links", click Update license. If prompted, enter the root password for your instance.

    Screenshot of the "User licenses" section of the "License" page. A link, labeled "Update license", is outlined in dark orange.

  6. To upload your license, click License file and select your license file. Alternatively, drag your license file onto the License file upload area.

    Screenshot of the "License" page of the Management Console. The "License file" upload area is highlighted with an orange outline.

  7. Click Upload. Your license will be updated in the background. The change may take a few minutes before it is visible on your instance.

Uploading your license with the REST API

You can use the REST API to upload a license to your GitHub Enterprise Server instance. See REST API endpoints for managing GitHub Enterprise Server.

Uploading a license with the GitHub CLI

You can import a license to your GitHub Enterprise Server instance using the gh es extension of the GitHub CLI. See the usage instructions in the github/gh-es repository on GitHub.com.

For more information about accessing your instance via the extension, see Administering your instance using the GitHub CLI.

Uploading a license via SSH

You can upload and interact with your license from the command line via SSH. See the documentation for the ghe-license command in Command-line utilities.

For more information about accessing your instance via SSH, see Accessing the administrative shell (SSH).