Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

managing-your-github-enterprise-license.md 8.0 KB

You have to be logged in to leave a comment. Sign In
title intro redirect_from versions
Managing your GitHub Enterprise license You can view, manage, and update your {% data variables.product.prodname_enterprise %} license. [/enterprise/admin/installation/managing-your-github-enterprise-license /enterprise/admin/categories/licenses/ /enterprise/admin/articles/license-files/ /enterprise/admin/installation/about-license-files/ /enterprise/admin/articles/downloading-your-license/ /enterprise/admin/installation/downloading-your-license/ /enterprise/admin/articles/upgrading-your-license/ /enterprise/admin/installation/updating-your-license/ /enterprise/admin/installation/managing-your-github-enterprise-server-license /enterprise/admin/overview/managing-your-github-enterprise-license] [{enterprise-server *}]

About {% data variables.product.prodname_enterprise %} licenses

When you purchase or renew {% data variables.product.prodname_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 {% data variables.product.prodname_enterprise %}. After you download and install {% data variables.product.prodname_enterprise %}, uploading the license file unlocks the application for you to use.

You can allocate the user licenses included in your {% data variables.product.prodname_enterprise %} license to users in {% data variables.product.product_location_enterprise %} and a {% data variables.product.prodname_ghe_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 {% data variables.product.prodname_enterprise %} email address must be the same as their verified {% data variables.product.prodname_ghe_cloud %} email address. You can sync license count and usage between the environments.

If your {% data variables.product.prodname_ghe_server %} license expires, you won't be able to access {% data variables.product.product_location_enterprise %} 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 {% data variables.contact.contact_enterprise_sales %}.

Uploading a new license to {% data variables.product.prodname_ghe_server %}

After you purchase a new license or upgrade an existing license from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file, then upload the file to {% data variables.product.prodname_ghe_server %} to unlock your new user licenses.

If you'd like to renew or add user licenses to {% data variables.product.prodname_enterprise %}, contact {% data variables.contact.contact_enterprise_sales %}. Your new license file will be available for download immediately after you complete your order.

{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} 3. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar 4. Under "Enterprise Server Instances", click {% octicon "download" aria-label="The download icon" %} to download your license file. Download GitHub Enterprise Server license 5. Log into your {% data variables.product.prodname_ghe_server %} instance as a site administrator. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} 12. Under "Quick links", click Update license. Update license link 13. To select your license, click License file, or drag your license file onto License file. Upload license file 14. Click Upload. Begin upload

{% if enterpriseVersion ver_lt "enterprise-server@3.0" %}If the web UI for {% data variables.product.prodname_ghe_server %} doesn't reflect your updated license immediately, see "Troubleshooting."{% endif %}

Viewing license usage

{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} 3. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar 4. Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.

Automatically syncing user license usage with {% data variables.product.prodname_ghe_cloud %}

You can use {% data variables.product.prodname_github_connect %} to automatically sync user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "Enabling automatic user license sync between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}."

Manually syncing user license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}

You can download a JSON file from {% data variables.product.prodname_ghe_server %} and upload the file to {% data variables.product.prodname_ghe_cloud %} to manually sync user license usage between the two deployments.

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} 5. Under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click Export license usage. Export license usage link {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} 8. In the left sidebar, click Enterprise licensing. "Enterprise licensing" tab in the enterprise account settings sidebar {% data reusables.enterprise-accounts.license-tab %} 10. Under "Enterprise Server Instances", click Add server usage. Upload GitHub Enterprise Servers usage link 11. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}. Drag and drop or select a file to upload

{% if currentVersion ver_lt "enterprise-server@3.0" %}

Troubleshooting

In some scenarios, the web UI for {% data variables.product.prodname_ghe_server %} may not immediately reflect your new license. You can force the system to detect the license by restarting two system services.

{% data reusables.enterprise_installation.ssh-into-instance %}

  1. Restart the services for Git authentication and the HTTP server.

    {% warning %}

    Warning: Running the following command will result in a few minutes of user-facing downtime for {% data variables.product.prodname_ghe_server %}. Run the command with care.

    {% endwarning %}

     sudo systemctl restart github-gitauth github-unicorn
    
  2. After {% data variables.product.prodname_ghe_server %} returns you to a prompt, try accessing {% data variables.product.prodname_ghe_server %} via the command line or web UI again.

{% endif %}

Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...