jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Minor updates to GHES billing docs following the EDI restructure and a quick check against the UI (#56886)

Browse Source 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Felicity Chapman
2025-07-31 09:20:53 +01:00
committed by GitHub
parent a9766e9a13
commit afb3f361b1
11 changed files with 37 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/enterprise/management-console/upload-license.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 78 KiB

2
content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md
View File

@@ -32,7 +32,7 @@ For guidance on a phased deployment of {% data variables.product.prodname_GHAS %
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. If your license includes {% data variables.product.prodname_GHAS_cs_or_sp %}, the license page includes a section showing details of current usage.
## Prerequisites for enabling {% data variables.product.prodname_cs_and_sp %}

8
content/billing/how-tos/manage-server-licenses/download-your-license.md
View File

@@ -47,8 +47,8 @@ There are two possible ways to download a license file for {% data variables.pro
If you have any questions about downloading your license, contact {% data variables.contact.contact_enterprise_sales %}. For more information about enterprise accounts, see [AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts){% ifversion ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}.{% endif %}
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
1. Under "Enterprise Server licenses", next to the license you want to download, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Download**.
{% data reusables.enterprise-accounts.licensing-tab-both-platforms %}
1. Optionally, if a yellow banner reports "Your license usage for Enterprise Cloud has changed. Generate a new license key to update server seats.", click **Generate new license** to generate a new license key.
1. Scroll down to "Enterprise Server licenses". Next to the license you want to download, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Download**.
After you download your license file, you can upload the file to {% data variables.location.product_location_enterprise %} to validate your application. For more information, see {% ifversion ghec %}[AUTOTITLE](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server) in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}[AUTOTITLE](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server).{% endif %}
After you download your license file, you can upload the file to {% data variables.product.prodname_ghe_server %} to validate your application. For more information, see {% ifversion ghec %}[AUTOTITLE](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server) in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}[AUTOTITLE](/enterprise-server@latest/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server).{% endif %}

11
content/billing/how-tos/manage-server-licenses/sync-license-usage.md
View File

@@ -33,7 +33,7 @@ When you synchronize license usage, only the user ID and email addresses for eac
## Automatically syncing license usage
You can use {% data variables.product.prodname_github_connect %} to automatically synchronize user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly. For more information, see [Enabling automatic user license sync for your enterprise]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise){% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}.{% endif %}
You can use {% data variables.product.prodname_github_connect %} to automatically synchronize user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly.
After you enable {% data variables.product.prodname_github_connect %}, license data will be automatically synchronized weekly. You can also manually synchronize your license data at any time, by triggering a license sync job.
@@ -42,9 +42,11 @@ After you enable {% data variables.product.prodname_github_connect %}, license d
1. Sign in to your {% data variables.product.prodname_ghe_server %} instance.
{% data reusables.enterprise-accounts.access-enterprise-ghes %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. Under "License sync", click **{% octicon "sync" aria-hidden="true" aria-label="sync" %} Sync now**.
If there is no **{% octicon "sync" aria-hidden="true" aria-label="sync" %} Sync now** button, you need to enable license synchronization. An information message, "License sync is disabled. You can enable it in the GitHub Connect settings" is shown. Click the "GitHub Connect settings" link. For more information, see [Enabling automatic user license sync for your enterprise]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise){% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}.{% endif %}
## Manually uploading GitHub Enterprise Server license usage
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.
@@ -52,12 +54,11 @@ You can download a JSON file from {% data variables.product.prodname_ghe_server
1. Sign in to your {% data variables.product.prodname_ghe_server %} instance.
{% data reusables.enterprise-accounts.access-enterprise-ghes %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. In the "User licenses" section, under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**.
![Screenshot of the "User licenses" section of the "License" page. A link, labeled "Export license usage", is outlined in dark orange.](/assets/images/enterprise/management-console/export-license-usage-link.png)
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.licensing-tab-both-platforms %}
1. Next to "Enterprise Server instances", click **Add server usage**.
1. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}.

25
content/billing/how-tos/manage-server-licenses/upload-new-license.md
View File

@@ -2,6 +2,7 @@
title: Uploading a new license to GitHub Enterprise Server
intro: 'You can upload your license file for {% data variables.product.prodname_enterprise %} to {% data variables.location.product_location_enterprise %} to validate your application.'
versions:
ghec: '*'
ghes: '*'
topics:
- Billing
@@ -13,36 +14,40 @@ redirect_from:
contentType: how-tos
---
## About license files for {% data variables.product.prodname_enterprise %}
## About license files for {% data variables.product.prodname_ghe_server %}
After you purchase or upgrade a license for {% data variables.product.prodname_enterprise %} from {% data variables.contact.contact_enterprise_sales %}, you must upload the new license file to {% data variables.location.product_location_enterprise %} to unlock your new user licenses. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise) and [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise).
When you purchase or download a new license for {% data variables.product.prodname_ghe_server %} you must upload the new license file to {% data variables.product.prodname_ghe_server %} to unlock your new user licenses.
If you use {% data variables.product.prodname_ghe_cloud %}, you can download a license from your enterprise. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise) and [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise).
{% data reusables.enterprise-licensing.contact-sales-for-renewals-or-seats %}
## Uploading your license from the {% data variables.enterprise.management_console %}
1. Sign into {% data variables.location.product_location_enterprise %} as a site administrator.
1. Sign into {% data variables.product.prodname_ghe_server %} as a site administrator.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
1. In the "User licenses" section, under "Quick links", click **Update license**.
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. 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.](/assets/images/enterprise/management-console/update-license-link.png)
1. To upload your license, click **License file**, or drag your license file onto **License file**.
1. 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. A link, labeled "License file", is highlighted with an orange outline.](/assets/images/enterprise/management-console/upload-license.png)
![Screenshot of the "License" page of the Management Console. The "License file" upload area is highlighted with an orange outline.](/assets/images/enterprise/management-console/upload-license.png)
1. 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 {% data variables.location.product_location %}. See [AUTOTITLE](/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license).
You can use the REST API to upload a license to {% data variables.location.product_location %}. {% ifversion ghec %}See [AUTOTITLE](/enterprise-server@latest/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license) in the documentation for {% data variables.product.prodname_ghe_server %}.{% elsif ghes %}See [AUTOTITLE](/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license).{% endif %}
## Uploading a license with the {% data variables.product.prodname_cli %}
You can import a license to {% data variables.location.product_location %} using the `gh es` extension of the {% data variables.product.prodname_cli %}. See the [usage instructions](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-config-import-license) in the `github/gh-es` repository on {% data variables.product.prodname_dotcom_the_website %}.
For more information about accessing your instance via the extension, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli).
For more information about accessing your instance via the extension, {% ifversion ghec %}see [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli) in the documentation for {% data variables.product.prodname_ghe_server %}.{% elsif ghes %}see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli).{% endif %}
## 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 [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-license). For more information about accessing your instance via SSH, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).
You can upload and interact with your license from the command line via SSH. See the documentation for the `ghe-license` command in {% ifversion ghec %}[AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-license) in the documentation for {% data variables.product.prodname_ghe_server %}.{% elsif ghes %}[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-license).{% endif %}
For more information about accessing your instance via SSH, see {% ifversion ghec %}[AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh) in the documentation for {% data variables.product.prodname_ghe_server %}.{% elsif ghes %}[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).{% endif %}

2
content/billing/how-tos/products/download-ghas-license-use.md
View File

@@ -77,7 +77,7 @@ You can download a CSV report for a repository, an organization, or an enterpris
{% elsif ghes %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. Under "{% data variables.product.prodname_GHAS %}," click **{% octicon "download" aria-hidden="true" aria-label="download" %} CSV report**.
![Screenshot of the licensing screen. The "CSV Report" button is highlighted with an orange outline.](/assets/images/enterprise/ghas/download-csv-report-ghes-3.9.png)

14
content/billing/how-tos/products/view-ghas-committers.md
View File

@@ -28,17 +28,17 @@ For more information about billing for {% data variables.product.prodname_AS %},
## Viewing committer information
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}.
1. In the left sidebar, click **Advanced Security Committers**.
1. To the right of "Current active committer count", view the number of active committers for repositories with {% data variables.product.prodname_cs_or_sp %} enabled. This is the number of licenses that are currently being used.
1. To the right of "Total billable committers if GHAS is enabled for all repositories", you can see the number of active committers across all the repositories in your enterprise. This is the number of licenses that would be used if you enabled {% data variables.product.prodname_cs_or_sp %} for every repository in your enterprise.
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %} to display the "Site admin" pages.
1. In the left sidebar, click **Advanced Security Committers**. If this option is not displayed, at the top of the page, click {% octicon "rocket" aria-hidden="true" aria-label="Site admin" %} **Site admin** to show the top-level "Site admin" page.
The page shows the number of licenses currently being used and the number of licenses you would use if you enabled {% data variables.product.prodname_AS %} for all repositories.
## Calculating the cost to add committers
Under "Calculate Additional Advanced Committers", you can calculate how many more new or additional licenses will be used if you enable {% data variables.product.prodname_cs_or_sp %} for specific organizations and repositories.
Under "Calculate Additional Advanced Licenses", you can calculate how many more new or additional licenses will be used if you enable {% data variables.product.prodname_cs_or_sp %} for specific organizations and repositories.
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}.
1. In the left sidebar, click **Advanced Security Committers**.
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %} to display the "Site admin" pages.
1. In the left sidebar, click **Advanced Security Committers**. If this option is not displayed, at the top of the page, click {% octicon "rocket" aria-hidden="true" aria-label="Site admin" %} **Site admin** to show the top-level "Site admin" page.
1. Under "Organizations and Repositories", enter or paste a list of organizations and repositories, with one organization or repository per line. For example:
```text

2
content/billing/how-tos/troubleshooting/enterprise-license-usage.md
View File

@@ -18,7 +18,7 @@ contentType: how-tos
## About unexpected license usage
If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise) and [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account).
If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise).
If you find errors, you can try troubleshooting steps.

2
content/support/contacting-github-support/providing-data-to-github-support.md
View File

@@ -134,7 +134,7 @@ You can use these steps to create and share a support bundle if you have SSH acc
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
{% data reusables.enterprise-accounts.license-tab-ghes %}
1. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**.
![Screenshot of the "GitHub Enterprise help" section of the enterprise settings page. The "Upload a support bundle link" is outlined in orange.](/assets/images/enterprise/support/upload-support-bundle.png)

1
data/reusables/enterprise-accounts/license-tab-ghes.md Normal file
View File

@@ -0,0 +1 @@
1. Under **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**, click **{% ifversion ghec %}Licensing{% elsif ghes %}License{% endif %}**.

3
data/reusables/enterprise-accounts/license-tab.md
View File

@@ -1,3 +0,0 @@
1. Under **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**, click **{% ifversion ghec %}Licensing{% elsif ghes %}License{% endif %}**. {% ifversion enhanced-billing-platform %}
>[!NOTE] If you are on the new billing platform, the licensing page has been relocated. See [AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/gathering-insights-on-your-spending#viewing-license-usage).{% endif %}