Home

Jump to bottom

German edited this page Nov 13, 2023 · 6 revisions

Deployment with docker

Step 1: Enviroment

Create a .env file from template.env

Get API Keys

How to get a GitHub API key
How to get a GitLab API key
How to get a NVD API key

Step 2: Deploy and Seed

Run command 'docker compose up --build' and seed the database with vulnerability info

Seeders

To use the API is mandatory to load the database with vulnerabilities and exploits, using the command script "seeds/vulndb_seeder.sh" on Linux systems or "seeds/vulndb_seeder.bat" on Windows systems.
You can create your graphs from scratch or load existing ones to help in the creation of new graphs (this task can be time consuming). To do this use the script "seeds/graphdb_seeder.sh" if you are on Linux or "graphdb_seeder.bat" if you are on Windows.

Step 3: Use

Enter here

Other tools

It is recommended to use a GUI such as MongoDB Compass to see what information is being indexed in vulnerability database
You can see the created graph built for pip, npm and mvn clicking in this names