This version of GitHub Enterprise will be discontinued on 2022-02-16. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Enabling GitHub Advanced Security for your enterprise

You can configure GitHub Enterprise Server to include GitHub Advanced Security. This provides extra features that help users find and fix security problems in their code.

GitHub Advanced Security is available for enterprise accounts on GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "About GitHub's products."

About enabling GitHub Advanced Security

GitHub Advanced Security helps developers improve and maintain the security and quality of code. For more information, see "About GitHub Advanced Security."

When you enable GitHub Advanced Security for your enterprise, repository administrators in all organizations can enable the features. For more information, see "Managing security and analysis settings for your organization" and "Managing security and analysis settings for your repository."

For guidance on a phased deployment of GitHub Advanced Security, see "Deploying GitHub Advanced Security in your enterprise."

Prerequisites for enabling GitHub Advanced Security

  1. Upgrade your license for GitHub Enterprise Server to include GitHub Advanced Security.

  2. Download the new license file. For more information, see "Downloading your license for GitHub Enterprise."

  3. Upload the new license file to your GitHub Enterprise Server instance. For more information, see "Uploading a new license to GitHub Enterprise Server."

  4. Review the prerequisites for the features you plan to enable.

Checking whether your license includes GitHub Advanced Security

  1. From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page. Rocketship icon for accessing site admin settings
  2. In the left sidebar, click Management Console. Management Console tab in the left sidebar
  3. If your license includes GitHub Advanced Security, there is an Advanced Security entry in the left sidebar. Advanced Security sidebar

If you can't see Advanced Security in the sidebar, it means that your license doesn't include support for Advanced Security features, including code scanning and secret scanning. The 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" or contact GitHub's Sales team.

Enabling and disabling GitHub Advanced Security features

Warning: Changing this setting will cause user-facing services on GitHub Enterprise Server to restart. You should time this change carefully, to minimize downtime for users.

  1. From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page. Rocketship icon for accessing site admin settings
  2. In the left sidebar, click Management Console. Management Console tab in the left sidebar
  3. In the left sidebar, click Advanced Security. Advanced Security sidebar
  4. Under "Advanced Security," select the features that you want to enable and deselect any features you want to disable. Checkbox to enable or disable Advanced Security features
  5. Under the left sidebar, click Save settings. The Save settings button in the Management Console
  6. Wait for the configuration run to complete.

When GitHub Enterprise Server has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "Configuring code scanning for your appliance."

Enabling or disabling GitHub Advanced Security features via the administrative shell (SSH)

You can enable or disable features programmatically on your GitHub Enterprise Server instance. For more information about the administrative shell and command-line utilities for GitHub Enterprise Server, see "Accessing the administrative shell (SSH)" and "Command-line utilities."

For example, you can enable any GitHub Advanced Security feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.

  1. SSH into your GitHub Enterprise Server instance.

  2. Enable features for GitHub Advanced Security.

    • To enable Code scanning, enter the following commands.
      ghe-config app.minio.enabled true
      ghe-config app.code-scanning.enabled true
    • To enable Secret scanning, enter the following command.
      ghe-config app.secret-scanning.enabled true
    • To enable Dependabot, enter the following commands.
      ghe-config app.github.dependency-graph-enabled true
      ghe-config app.github.vulnerability-alerting-and-settings-enabled true
  3. Optionally, disable features for GitHub Advanced Security.

    • To disable code scanning, enter the following commands.
      ghe-config app.minio.enabled false
      ghe-config app.code-scanning.enabled false
    • To disable secret scanning, enter the following command.
      ghe-config app.secret-scanning.enabled false
    • To disable Dependabot, enter the following commands.
      ghe-config app.github.dependency-graph-enabled false
      ghe-config app.github.vulnerability-alerting-and-settings-enabled false
  4. Apply the configuration.

    ghe-config-apply

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.