Skip to content

Commit 84470a7

Browse files
committed
updating translations content
1 parent 68abd46 commit 84470a7

File tree

78 files changed

+1399
-39
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+1399
-39
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: About licensing for GitHub Advanced Security
3+
intro: 'You need a license to use {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}.'
4+
product: '{% data reusables.gated-features.ghas %}'
5+
versions:
6+
enterprise-server: '>=3.1'
7+
type: overview
8+
topics:
9+
- Advanced Security
10+
- Enterprise
11+
- Licensing
12+
- Security
13+
redirect_from:
14+
- /admin/advanced-security/about-licensing-for-github-advanced-security
15+
---
16+
17+
## About licensing for {% data variables.product.prodname_GH_advanced_security %}
18+
19+
You can make extra features for code security available to users by buying and uploading a license for {% data variables.product.prodname_GH_advanced_security %}. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."
20+
21+
{% data reusables.advanced-security.license-overview %}
22+
23+
To discuss licensing {% data variables.product.prodname_GH_advanced_security %} for {% data variables.product.product_name %}, contact {% data variables.contact.contact_enterprise_sales %}. To enable {% data variables.product.prodname_GH_advanced_security %}, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your appliance](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)."
24+
25+
## About committer numbers for {% data variables.product.prodname_GH_advanced_security %}
26+
27+
{% data reusables.advanced-security.about-committer-numbers-ghec-ghes %}
28+
29+
## Managing your license usage for {% data variables.product.prodname_GH_advanced_security %}
30+
31+
{% data reusables.advanced-security.managing-license-usage-ghec-ghes %}
32+
33+
You can enforce policies to allow or disallow the use of {% data variables.product.prodname_advanced_security %} by organizations owned by your enterprise account. For more information, see "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)."
34+
35+
For more information on viewing license usage, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/admin/advanced-security/viewing-your-github-advanced-security-usage)."
36+
37+
## Getting the most out of your {% data variables.product.prodname_GH_advanced_security %} license
38+
39+
{% data reusables.advanced-security.getting-the-most-from-your-license %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: Configuring code scanning for your appliance
3+
shortTitle: Configuring code scanning
4+
intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.'
5+
product: '{% data reusables.gated-features.code-scanning %}'
6+
miniTocMaxHeadingLevel: 3
7+
redirect_from:
8+
- /enterprise/admin/configuration/configuring-code-scanning-for-your-appliance
9+
- /admin/configuration/configuring-code-scanning-for-your-appliance
10+
- /admin/advanced-security/configuring-code-scanning-for-your-appliance
11+
versions:
12+
enterprise-server: '>=2.22'
13+
type: how_to
14+
topics:
15+
- Advanced Security
16+
- Code scanning
17+
- Enterprise
18+
- Security
19+
---
20+
21+
{% data reusables.code-scanning.beta %}
22+
23+
## About {% data variables.product.prodname_code_scanning %}
24+
25+
{% data reusables.code-scanning.about-code-scanning %}
26+
27+
You can configure {% data variables.product.prodname_code_scanning %} to run {% data variables.product.prodname_codeql %} analysis and third-party analysis. {% data variables.product.prodname_code_scanning_capc %} also supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure. The table below summarizes all the options available to users when you configure {% data variables.product.product_location %} to allow {% data variables.product.prodname_code_scanning %} using actions.
28+
29+
{% data reusables.code-scanning.enabling-options %}
30+
31+
## Prerequisites for {% data variables.product.prodname_code_scanning %}
32+
33+
- A license for {% data variables.product.prodname_GH_advanced_security %}{% if currentVersion ver_gt "[email protected]" %} (see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/admin/advanced-security/about-licensing-for-github-advanced-security)"){% endif %}
34+
35+
- {% data variables.product.prodname_code_scanning_capc %} 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)")
36+
37+
- A VM or container for {% data variables.product.prodname_code_scanning %} analysis to run in.
38+
39+
## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %}
40+
41+
### Setting up a self-hosted runner
42+
43+
{% data variables.product.prodname_ghe_server %} can run {% data variables.product.prodname_code_scanning %} using a {% data variables.product.prodname_actions %} workflow. First, you need to provision one or more self-hosted {% data variables.product.prodname_actions %} runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."
44+
45+
You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions.
46+
47+
### Provisioning the actions for {% data variables.product.prodname_code_scanning %}
48+
49+
{% if currentVersion ver_gt "[email protected]" %}
50+
If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance.
51+
52+
The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below.
53+
54+
You can also make third-party actions available to users for {% data variables.product.prodname_code_scanning %}, by setting up {% data variables.product.prodname_github_connect %}. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)" below.
55+
56+
### Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access
57+
If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, and you want to allow users to enable {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for their repositories, you must use the {% data variables.product.prodname_codeql %} action sync tool to copy the {% data variables.product.prodname_codeql %} analysis bundle from {% data variables.product.prodname_dotcom_the_website %} to your server. The tool, and details of how to use it, are available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/).
58+
59+
If you set up the {% data variables.product.prodname_codeql %} action sync tool, you can use it to sync the latest releases of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql %} analysis bundle. These are compatible with {% data variables.product.prodname_ghe_server %}.
60+
61+
{% endif %}
62+
63+
{% if currentVersion == "[email protected]" %}
64+
To run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %}, the appropriate actions must be available locally. You can make the actions available in three ways.
65+
66+
- **Recommended**: You can use [{% data variables.product.prodname_github_connect %}](/enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud) to automatically download actions from {% data variables.product.prodname_dotcom_the_website %}. The machine that hosts your instance must be able to access {% data variables.product.prodname_dotcom_the_website %}. This approach ensures that you get the latest software automatically. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)."
67+
- If you want to use the {% data variables.product.prodname_codeql_workflow %}, you can sync the repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}, by using the {% data variables.product.prodname_codeql %} Action sync tool available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). You can use this tool regardless of whether {% data variables.product.product_location %} or your {% data variables.product.prodname_actions %} runners have access to the internet, as long as you can access both {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %} simultaneously on your computer.
68+
- You can create a local copy of an action's repository on your server, by cloning the {% data variables.product.prodname_dotcom_the_website %} repository that contains the action. For example, if you want to use the actions for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you can create a repository in your instance called `github/codeql-action`, then clone the [repository](https://github.com/github/codeql-action) from {% data variables.product.prodname_dotcom_the_website %}, and then push that repository to your instance's `github/codeql-action` repository. You will also need to download any of the releases from the repository on {% data variables.product.prodname_dotcom_the_website %} and upload them to your instance's `github/codeql-action` repository as releases.
69+
{% endif %}
70+
71+
### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}
72+
1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud#enabling-github-connect)."
73+
2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)."
74+
3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
75+
4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."
76+
77+
## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}
78+
If you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}.
79+
80+
The {% data variables.product.prodname_codeql_runner %} is a command-line tool that you can add to your third-party CI/CD system. The tool runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. For more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)."
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Configuring secret scanning for your appliance
3+
shortTitle: Configuring secret scanning
4+
intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.'
5+
product: '{% data reusables.gated-features.secret-scanning %}'
6+
miniTocMaxHeadingLevel: 3
7+
redirect_from:
8+
- /admin/configuration/configuring-secret-scanning-for-your-appliance
9+
- /admin/advanced-security/configuring-secret-scanning-for-your-appliance
10+
versions:
11+
enterprise-server: '>=3.0'
12+
type: how_to
13+
topics:
14+
- Advanced Security
15+
- Enterprise
16+
- Secret scanning
17+
- Security
18+
---
19+
20+
{% data reusables.secret-scanning.beta %}
21+
22+
## About {% data variables.product.prodname_secret_scanning %}
23+
24+
{% 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)."
25+
26+
## Prerequisites for {% data variables.product.prodname_secret_scanning %}
27+
28+
29+
- The [SSSE3](https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf#G3.1106470) (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs {% data variables.product.product_location %}.
30+
31+
- A license for {% data variables.product.prodname_GH_advanced_security %}{% if currentVersion ver_gt "[email protected]" %} (see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/admin/advanced-security/about-licensing-for-github-advanced-security)"){% endif %}
32+
33+
- {% 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)")
34+
35+
## Checking support for the SSSE3 flag on your vCPUs
36+
37+
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.
38+
39+
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)."
40+
2. Enter the following command:
41+
42+
```shell
43+
grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $?
44+
```
45+
46+
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.
47+
48+
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+
50+
### Checking whether you have an {% data variables.product.prodname_advanced_security %} license
51+
52+
{% data reusables.enterprise_site_admin_settings.access-settings %}
53+
{% data reusables.enterprise_site_admin_settings.management-console %}
54+
1. Check if there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar.
55+
![Advanced Security sidebar](/assets/images/enterprise/management-console/sidebar-advanced-security.png)
56+
57+
{% data reusables.enterprise_management_console.advanced-security-license %}
58+
59+
## Enabling {% data variables.product.prodname_secret_scanning %}
60+
61+
{% data reusables.enterprise_management_console.enable-disable-security-features %}
62+
63+
{% data reusables.enterprise_site_admin_settings.access-settings %}
64+
{% data reusables.enterprise_site_admin_settings.management-console %}
65+
{% data reusables.enterprise_management_console.advanced-security-tab %}
66+
1. Under "{% data variables.product.prodname_advanced_security %}," click **{% data variables.product.prodname_secret_scanning_caps %}**.
67+
![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/enable-secret-scanning-checkbox.png)
68+
{% data reusables.enterprise_management_console.save-settings %}
69+
70+
## Disabling {% data variables.product.prodname_secret_scanning %}
71+
72+
{% data reusables.enterprise_management_console.enable-disable-security-features %}
73+
74+
{% data reusables.enterprise_site_admin_settings.access-settings %}
75+
{% data reusables.enterprise_site_admin_settings.management-console %}
76+
{% data reusables.enterprise_management_console.advanced-security-tab %}
77+
1. Under "{% data variables.product.prodname_advanced_security %}", unselect **{% data variables.product.prodname_secret_scanning_caps %}**.
78+
![Checkbox to enable or disable {% data variables.product.prodname_secret_scanning %}](/assets/images/enterprise/management-console/secret-scanning-disable.png)
79+
{% data reusables.enterprise_management_console.save-settings %}

0 commit comments

Comments
 (0)