Skip to content

Commit 5b09040

Browse files
authored
Merge pull request #32424 from github/repo-sync
Repo sync
2 parents f85e39f + 9177b20 commit 5b09040

File tree

2 files changed

+86
-5
lines changed

2 files changed

+86
-5
lines changed

content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md

Lines changed: 64 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,6 +1132,67 @@ This utility rewrites the imported repository. This gives you a chance to rename
11321132
git-import-rewrite
11331133
```
11341134

1135+
{% ifversion ghes > 3.12 %}
1136+
1137+
## License
1138+
1139+
### ghe-license
1140+
1141+
This utility lets you interact with your current active license, or with new licenses without needing to import them first. You can also directly apply the license to make the changes effective using `--apply`. Applying changes with the `ghe-license` utility avoids a configuration run and only restarts the affected services.
1142+
1143+
You can review the possible commands and flags using `ghe-license -h`.
1144+
1145+
Alternatively, you can manage licenses using the REST API or the {% data variables.product.prodname_cli %}. See "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)."
1146+
1147+
Display license information. Alternatively, use the `-j` flag for JSON formatting.
1148+
1149+
```shell
1150+
ghe-license info
1151+
# "advanced_security_enabled" : true
1152+
# "advanced_security_seats" : 0
1153+
# "cluster_support" : false
1154+
# "company" : "GitHub"
1155+
# "croquet_support" : true
1156+
# "custom_terms" : true
1157+
# "evaluation" : false
1158+
# "expire_at" : "2025-01-01T23:59:59-08:00"
1159+
# "insights_enabled" : true
1160+
# "insights_expire_at" : "2025-01-01T23:59:59.999-08:00"
1161+
# "learning_lab_evaluation_expires" : "2023-01-01T23:59:59.000-08:00"
1162+
# "learning_lab_seats" : 100
1163+
# "perpetual" : false
1164+
# "reference_number" : "123456"
1165+
# "seats" : 0
1166+
# "ssh_allowed" : true
1167+
# "support_key" : null
1168+
# "unlimited_seating" : true
1169+
```
1170+
1171+
Check the license.
1172+
1173+
```shell
1174+
ghe-license check
1175+
# License is valid.
1176+
```
1177+
1178+
All commands are performed on the existing license. However, you can also provide a license from STDOUT using `--pipe`.
1179+
1180+
```shell
1181+
cat license | ghe-license import --pipe
1182+
# License imported at /data/user/common/enterprise.ghl.
1183+
# License synchronized.
1184+
```
1185+
1186+
You can also provide a license by assigning a file path to the `GHE_LICENSE_FILE` environment variable.
1187+
1188+
```shell
1189+
GHE_LICENSE_FILE=/path/license ghe-license import
1190+
# License imported at /data/user/common/enterprise.ghl.
1191+
# License synchronized.
1192+
```
1193+
1194+
{% endif %}
1195+
11351196
## Security
11361197

11371198
### ghe-find-insecure-git-operations
@@ -1314,14 +1375,14 @@ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME
13141375
13151376
## User management
13161377
1317-
### ghe-license-usage
1378+
### {% ifversion ghes > 3.12 %}ghe-license usage{% else %}ghe-license-usage{% endif %}
13181379
13191380
This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect)."
13201381

1321-
By default, the list of users in the resulting JSON file is encrypted. Use the `-h` flag for more options.
1382+
By default, the list of users in the resulting JSON file is encrypted. {% ifversion ghes > 3.12 %}Review optional flags via `ghe-license --help`{% else %}Use the `-h` flag for more options{% endif %}.
13221383

13231384
```shell
1324-
ghe-license-usage
1385+
{% ifversion ghes > 3.12 %}ghe-license usage{% else %}ghe-license-usage{% endif %}
13251386
```
13261387

13271388
### ghe-org-membership-update

content/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ After you purchase or upgrade a license for {% data variables.product.prodname_e
1616

1717
{% data reusables.enterprise-licensing.contact-sales-for-renewals-or-seats %}
1818

19-
## Uploading your license to {% data variables.location.product_location_enterprise %}
19+
## Uploading your license from the {% data variables.enterprise.management_console %}
2020

21+
{% ifversion ghes < 3.13 %}
2122
{% warning %}
2223

2324
**Warning:** Updating your license causes a small amount of downtime for {% data variables.location.product_location %}.
2425

2526
{% endwarning %}
27+
{% endif %}
2628

2729
1. Sign into {% data variables.location.product_location_enterprise %} as a site administrator.
2830
{% data reusables.enterprise-accounts.access-enterprise %}
@@ -34,4 +36,22 @@ After you purchase or upgrade a license for {% data variables.product.prodname_e
3436
1. To upload your license, click **License file**, or drag your license file onto **License file**.
3537

3638
![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)
37-
1. Click **Upload**.
39+
1. Click **Upload**.{% ifversion ghes > 3.12 %} Your license will be updated in the background. The change may take a few minutes before it is visible on your instance.{% endif %}
40+
41+
{% ifversion ghes > 3.12 %}
42+
43+
## Uploading your license with the REST API
44+
45+
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)."
46+
47+
## Uploading a license with the {% data variables.product.prodname_cli %}
48+
49+
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 %}.
50+
51+
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)."
52+
53+
## Uploading a license via SSH
54+
55+
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)."
56+
57+
{% endif %}

0 commit comments

Comments
 (0)