Welcome to VulnerableCode!
=============================

*VulnerableCode* provides an open database of software packages that are affected
by known security vulnerabilities aka. *"vulnerable packages"*.

VulnerableCode is also a free and open source software (FOSS) project that
provides the tools to build this open database. The tools handle collecting,
aggregating and correlating these vulnerabilities and relating them to a correct
package version. Our project also supports a public cloud instance of this
database - VulnerableCode.io.

In this documentation you will find information on:

- An overview of VulnerableCode and what you can do with it
- Installation instructions
- How to make technical contributions to the project and the community

.. toctree::
    :maxdepth: 2
    :caption: Getting Started

    introduction
    user-interface
    installation
    api
    api-admin
    contributing
    faq
    misc

.. toctree::
    :maxdepth: 2
    :caption: Tutorial

    tutorial_add_importer_pipeline
    tutorial_add_improver_pipeline


.. toctree::
    :maxdepth: 2
    :caption: Reference Documentation

    reference_importer_overview
    reference_improver_overview
    reference_framework_overview
    reference_model_overview
    command-line-interface
    importers_link

.. toctree::
   :maxdepth: 1
   :caption: Summer of Codes

   soc_gsoc21

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
