* new article scaffolding * Add scaffolding * Migrate content for overview article * Add placeholder notes and migrate over some more content * First draft of updates to existing docs * Add H2 headers to the article * Draft of phase 0 content * Update phase 0 with more drafting * Fix subheaders and table formatting * Add unedited and slightly tweaked source material * Current draft of reworked content * Refactor everything * Add best practices and some partnership details * Touch-ups * Touch up intro and create a phased approaches reusable * Fix the intro * Move reusable * Add image for GHES versions * Fix links * Add HTML note around links that need to be versioned for GHEC once the GHEC version releases * Fix reusable * Tidy up session * Versioning around the links * migrate this content to another PR for easier reviewing * Add HTML note about versioning for GHEC * Revamp intro * Add product variables * Less is more in the intro * Fix the beginning * Copy-edits for first half * Add Markdown-friendly bullet points * unclear shift direction * Distinguish the rollout team roles * More active language & cut the note * Maybe too wordy * Edit facts section * Update the article path to fix tests * Add product variables for professional services * Another revision * More tidying * Fix spacing * Apply suggestions from code review Co-authored-by: Felicity Chapman <felicitymay@github.com> * Apply suggestions from code review Co-authored-by: Felicity Chapman <felicitymay@github.com> * Apply @felicitymay's input * Apply suggestions from code review Co-authored-by: Rachael Sewell <rachmari@github.com> * Fix link test by adding HTML note around GHEC only article for now * Apply @felicitymay's stellar input 🌠 Co-authored-by: Felicity Chapman <felicitymay@github.com> * Apply suggestions from code review * Apply suggestions from code review * GitHub Advanced Security "Deploying" guide (#22114) * Add draft content * Add gated features reusable * Revise draft * Revamp steps of phase 0 * Replace goals section with intro text * More revising * Standardize headers with sentence case & remove overview subheader * Phase 0 streamlined * Fix intro and GHAS Guidebook reference * Fix reusable * Phase 1 💖 * Phase 2 tightened * Standardize on subheaders * Update phase 3 * Add product variable * Fix some links to fix the tests * Apply @felicitymay's stellar input 🌠 Co-authored-by: Felicity Chapman <felicitymay@github.com> * Apply Felicity's input * Use more GHAS to ease the reading load * Update resusable * Replacing "organization" * Add dependency review verisoning Co-authored-by: “jmarlena” <“jmarlena@github.com”> Co-authored-by: Felicity Chapman <felicitymay@github.com> * Remove draft notes for appendix links * Fix subheader * Deploying before enabling GHAS * Replace organization * Fix variables * Add GHEC & GHES versioning * not sure why this space is a commit * Apply suggestions from code review Co-authored-by: Felicity Chapman <felicitymay@github.com> * Remove ghec versioning we don't need * Add repo reference * Remove versioning note ftw * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Markdown, I love you Co-authored-by: Megan Christudas <meganchristudas@Megans-MBP.fios-router.home> Co-authored-by: jmarlena <jmarlena@github.com> Co-authored-by: “jmarlena” <“jmarlena@github.com”> Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
79 lines
6.5 KiB
Markdown
79 lines
6.5 KiB
Markdown
---
|
|
title: About GitHub Advanced Security
|
|
intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% ifversion fpt or ghec %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}'
|
|
product: '{% data reusables.gated-features.ghas %}'
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '>=3.0'
|
|
ghae: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- Security
|
|
redirect_from:
|
|
- /github/getting-started-with-github/about-github-advanced-security
|
|
- /github/getting-started-with-github/learning-about-github/about-github-advanced-security
|
|
shortTitle: GitHub Advanced Security
|
|
---
|
|
## About {% data variables.product.prodname_GH_advanced_security %}
|
|
|
|
{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% ifversion not ghae %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}.
|
|
|
|
{% ifversion fpt or ghes > 3.0 or ghec %}For more information about purchasing {% data variables.product.prodname_GH_advanced_security %}, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% elsif ghae %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %}
|
|
|
|
## About {% data variables.product.prodname_advanced_security %} features
|
|
|
|
A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features:
|
|
|
|
- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)."
|
|
|
|
- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)."
|
|
|
|
{% ifversion fpt or ghes > 3.1 or ghec %}
|
|
- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
|
{% endif %}
|
|
|
|
For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)."
|
|
|
|
{% ifversion ghes > 2.22 or ghec %}
|
|
|
|
## Deploying GitHub Advanced Security in your enterprise
|
|
|
|
To learn about what you need to know to plan your {% data variables.product.prodname_GH_advanced_security %} deployment at a high level, see "[Overview of {% data variables.product.prodname_GH_advanced_security %}](/admin/advanced-security/overview-of-github-advanced-security-deployment)."
|
|
|
|
To review the rollout phases we recommended in more detail, see "[Deploying {% data variables.product.prodname_GH_advanced_security %} in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)."
|
|
|
|
{% endif %}
|
|
|
|
{% ifversion ghes > 2.22 or ghae %}
|
|
## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}
|
|
|
|
{% ifversion ghes > 2.22 %}
|
|
The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)."
|
|
{% endif %}
|
|
|
|
Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
|
|
|
{% endif %}
|
|
|
|
{% ifversion not ghae %}
|
|
## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %}
|
|
|
|
For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public.
|
|
|
|
For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% ifversion fpt or ghes > 3.0 or ghec %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %}
|
|
|
|
{% endif %}
|
|
|
|
{% ifversion fpt or ghec %}
|
|
If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage)."
|
|
|
|
{% endif %}
|
|
|
|
{% ifversion ghec or ghes > 3.0 or ghae-next %}
|
|
|
|
## Further reading
|
|
|
|
- "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise account](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)"
|
|
|
|
{% endif %}
|