VulnerableCode Documentation

VulnerableCode provides a Web UI and API to access a database of known software package vulnerabilities with comprehensive information from upstream and downstream public sources including packages affected by a vulnerability and packages that fix a vulnerability.

There is a public VulnerableCode database and the project also provides the tools to build your own instance of the database.

Documentation overview

The overview below outlines how the documentation is structured to help you know where to look for certain things.

Getting started

Start here if you are new to VulnerableCode.

• VulnerableCode Overview

• User Interface

• Installation

• API overview

• API usage administration for on-premise deployments

• Package Endpoint

• Contributing to VulnerableCode

Tutorials

Learn via practical step-by-step guides.

• Add a new pipeline to import advisories

• Add pipeline to improve/enhance data

Reference Docs

Reference documentation for VulnerableCode features and customizations.

• Importer Overview

• Improver Overview

• Framework Overview

• Model Overview

• Command Line Interface

• Importers

• Pipelines AVID Mapping

• Sources

Explanations

Consult the reference to understand VulnerableCode concepts.

Misc

• FAQ

• Miscellaneous

• Google Summer of Code 2021 Final Report

Indices and tables

• Index

• Module Index

• Search Page