Skip to content

Commit 4fba52e

Browse files
authored
Refactor info explaining to GHES admins how to check whether they have a GHAS license (#23125)
* explain to users how to check whether they have a GHAS license
1 parent c94e6ba commit 4fba52e

6 files changed

Lines changed: 28 additions & 32 deletions

File tree

content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ You can configure {% data variables.product.prodname_code_scanning %} to run {%
2727

2828
{% data reusables.code-scanning.enabling-options %}
2929

30+
## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %}
31+
32+
{% data reusables.advanced-security.check-for-ghas-license %}
33+
3034
## Prerequisites for {% data variables.product.prodname_code_scanning %}
3135

3236
- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes > 3.0 %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)"){% endif %}

content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ topics:
2222

2323
{% data reusables.secret-scanning.about-secret-scanning %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)."
2424

25+
## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %}
26+
27+
{% data reusables.advanced-security.check-for-ghas-license %}
28+
2529
## Prerequisites for {% data variables.product.prodname_secret_scanning %}
2630

2731

@@ -31,33 +35,20 @@ topics:
3135

3236
- {% data variables.product.prodname_secret_scanning_caps %} enabled in the management console (see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)")
3337

34-
## Checking support for the SSSE3 flag on your vCPUs
38+
### Checking support for the SSSE3 flag on your vCPUs
3539

3640
The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance.
3741

3842
1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)."
3943
2. Enter the following command:
4044

41-
```shell
42-
grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $?
43-
```
44-
45-
If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below.
45+
```shell
46+
grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $?
47+
```
4648

47-
If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs.
49+
If this returns the value `0`, it means that the SSSE3 flag is available and enabled. You can now enable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_secret_scanning %}](#enabling-secret-scanning)" below.
4850

49-
### Checking whether you have an {% data variables.product.prodname_advanced_security %} license
50-
51-
{% data reusables.enterprise_site_admin_settings.access-settings %}
52-
{% data reusables.enterprise_site_admin_settings.management-console %}
53-
1. Check if there is {% ifversion ghes < 3.2 %}an **{% data variables.product.prodname_advanced_security %}**{% else %}a **Security**{% endif %} entry in the left sidebar.
54-
{% ifversion ghes < 3.2 %}
55-
![Advanced Security sidebar](/assets/images/enterprise/management-console/sidebar-advanced-security.png)
56-
{% else %}
57-
![Security sidebar](/assets/images/enterprise/3.2/management-console/sidebar-security.png)
58-
{% endif %}
59-
60-
{% data reusables.enterprise_management_console.advanced-security-license %}
51+
If this doesn't return `0`, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs.
6152

6253
## Enabling {% data variables.product.prodname_secret_scanning %}
6354

content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,6 @@ When you enable {% data variables.product.prodname_GH_advanced_security %} for y
2828
For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)."
2929
{% endif %}
3030

31-
## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %}
32-
33-
1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %}
34-
2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."
35-
3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %}
36-
4. Review the prerequisites for the features you plan to enable.
37-
38-
- {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)."
39-
- {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %}
40-
- {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)."
41-
4231
## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %}
4332

4433
{% ifversion ghes > 3.0 %}
@@ -58,6 +47,17 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying
5847
{% data reusables.enterprise_management_console.advanced-security-license %}
5948
{% endif %}
6049

50+
## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %}
51+
52+
1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %}
53+
2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."
54+
3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %}
55+
4. Review the prerequisites for the features you plan to enable.
56+
57+
- {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)."
58+
- {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %}
59+
- {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)."
60+
6161
## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features
6262

6363
{% data reusables.enterprise_management_console.enable-disable-security-features %}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing {% ifversion ghes = 3.0 %}the {% data variables.enterprise.management_console %}{% elsif ghes > 3.0 %}your enterprise settings{% endif %}. For more information, see "[Enabling GitHub Advanced Security for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)."
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
If you can't see {% ifversion ghes < 3.2 %}**{% data variables.product.prodname_advanced_security %}**{% else %}**Security**{% endif %} in the sidebar, it means that your license doesn't include support for {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. The {% data variables.product.prodname_advanced_security %} license gives you and your users access to features that help you make your repositories and code more secure. {% ifversion ghes %}For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}.{% endif %}
1+
If you can't see **{% data variables.product.prodname_advanced_security %}** in the sidebar, it means that your license doesn't include support for {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. The {% data variables.product.prodname_advanced_security %} license gives you and your users access to features that help you make your repositories and code more secure. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)" or contact {% data variables.contact.contact_enterprise_sales %}.

data/variables/contact.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ contact_dmca: >-
1515
contact_privacy: >-
1616
{% ifversion fpt or ghec %}[Privacy contact form](https://github.com/contact/privacy){% endif %}
1717
18-
contact_enterprise_sales: "[GitHub's Sales team](https://enterprise.github.com/contact)"
18+
contact_enterprise_sales: "[GitHub's Sales team](https://github.com/enterprise/contact)"
1919

2020
contact_feedback_actions: '[Feedback form for GitHub Actions](https://support.github.com/contact/feedback?contact[category]=actions)'
2121

0 commit comments

Comments
 (0)