Enabling the dependency graph for your enterprise

About the dependency graph

The dependency graph is a summary of the manifest and lock files stored in a repository and any dependencies that are submitted for the repository using the dependency submission API (beta). For each repository, it shows dependencies, the ecosystems and packages it depends on.

For each dependency, you can see the vulnerability severity. You can also search for a specific dependency using the search bar. Dependencies are sorted automatically by vulnerability severity.

GitHub Enterprise Server does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. For more information, see " About the dependency graph "

After you enable the dependency graph, users will have access to the dependency review feature. Dependency review helps you understand dependency changes and the security impact of these changes at every pull request. For more information, see " About dependency review ."

After you enable the dependency graph for your enterprise, you can enable Dependabot to detect insecure dependencies in your repository and automatically fix the vulnerabilities. For more information, see " Enabling Dependabot for your enterprise ."

You can enable the dependency graph via the Management Console or the administrative shell. We recommend using the Management Console unless your GitHub Enterprise Server instance uses clustering.

Enabling the dependency graph via the Management Console

If your GitHub Enterprise Server instance uses clustering, you cannot enable the dependency graph with the Management Console and must use the administrative shell instead. For more information, see " Enabling the dependency graph via the administrative shell ."

1. Sign in to your GitHub Enterprise Server instance at http(s)://HOSTNAME/login .

2. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

3. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin .

4. In the " Site admin" sidebar, click Management Console .

5. In the "Settings" sidebar, click Security .

6. Under "Security," select Dependency graph .

7. Under the "Settings" sidebar, click Save settings .

   Note: Saving settings in the Management Console restarts system services, which could result in user-visible downtime.

8. Wait for the configuration run to complete.

9. Click Visit your instance .

Enabling the dependency graph via the administrative shell

1. Sign in to your GitHub Enterprise Server instance at http(s)://HOSTNAME/login .

2. In the administrative shell, enable the dependency graph on your GitHub Enterprise Server instance:

   ghe-config app.dependency-graph.enabled true
   

   Note : For more information about enabling access to the administrative shell via SSH, see " Accessing the administrative shell (SSH) ."

3. Apply the configuration.

   ghe-config-apply
   

4. Return to GitHub Enterprise Server.