About alerts for vulnerable dependencies on your GitHub Enterprise Server instance
GitHub identifies vulnerable dependencies in repositories and creates Dependabot alerts on your GitHub Enterprise Server instance, using:
- Data from the GitHub Advisory Database
- The dependency graph service
For more information about these features, see "About the dependency graph" and "About alerts for vulnerable dependencies."
About synchronization of data from the GitHub Advisory Database
We add vulnerabilities to the GitHub Advisory Database from the following sources:
- The National Vulnerability Database
- A combination of machine learning and human review to detect vulnerabilities in public commits on GitHub
- Security advisories reported on GitHub
- The npm Security advisories database
You can connect your GitHub Enterprise Server instance to GitHub.com with GitHub Connect. Once connected, vulnerability data is synced from the GitHub Advisory Database to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from your GitHub Enterprise Server instance is uploaded to GitHub.com.
About generation of Dependabot alerts
If you enable vulnerability detection, when your GitHub Enterprise Server instance receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates Dependabot alerts. You can choose whether or not to notify users automatically about new Dependabot alerts.
Enabling the dependency graph and Dependabot alerts for vulnerable dependencies on your GitHub Enterprise Server instance
Prerequisites
For your GitHub Enterprise Server instance to detect vulnerable dependencies and generate Dependabot alerts:
- You must connect your GitHub Enterprise Server instance to GitHub.com. For more information, see "Connecting your enterprise account to GitHub Enterprise Cloud."
- You must enable the dependency graph service.
- You must enable vulnerability scanning.
Enabling the dependency graph
-
Sign in to your GitHub Enterprise Server instance at
http(s)://HOSTNAME/login
. -
In the administrative shell, enable the dependency graph on your GitHub Enterprise Server instance:
$ ghe-config app.github.dependency-graph-enabled true
Note: For more information about enabling access to the administrative shell via SSH, see "Accessing the administrative shell (SSH)."
-
Apply the configuration.
$ ghe-config-apply
-
Return to GitHub Enterprise Server.
Enabling Dependabot alerts
Before enabling Dependabot alerts for your instance, you need to enable the dependency graph. For more information, see above.
-
In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings.
-
In the enterprise account sidebar, click Settings.
-
In the left sidebar, click GitHub Connect.
-
Under "Repositories can be scanned for vulnerabilities", select the drop-down menu and click Enabled without notifications. Optionally, to enable alerts with notifications, click Enabled with notifications.
Tip: We recommend configuring Dependabot alerts without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive Dependabot alerts as usual.
Viewing vulnerable dependencies on your GitHub Enterprise Server instance
You can view all vulnerabilities in your GitHub Enterprise Server instance and manually sync vulnerability data from GitHub.com to update the list.
- From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page.
- In the left sidebar, click Vulnerabilities.
- To sync vulnerability data, click Sync Vulnerabilities now.