FLOSS-Security
/
foss-vuln-tracker
mirror of https://github.com/standash/foss-vuln-tracker
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README

This commit is contained in:
standash 2019-06-04 14:19:40 +02:00
parent c79d9ca3b0
commit 43f9ca943f
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,6 +1,4 @@
-------------------- ##About
About
--------------------
This is a project for collecting the vulnerability evidence from source code repositories. This is a project for collecting the vulnerability evidence from source code repositories.
@ -21,9 +19,9 @@ The project consists of two parts:
identify and track the potentially vulnerable coding. identify and track the potentially vulnerable coding.
-------------------- ##Usage
Prerequisites
-------------------- ####Prerequisites
1. Java compiler and runtime (tested with jdk 1.8). 1. Java compiler and runtime (tested with jdk 1.8).
@ -32,9 +30,7 @@ Prerequisites
3. MongoDB (tested with version 3.4) 3. MongoDB (tested with version 3.4)
* make sure the mongodb service is running * make sure the mongodb service is running
-------------------- ####Building and packaging
Building and packaging
--------------------
Building with Maven is pretty straightforward. The following commands are Building with Maven is pretty straightforward. The following commands are
available: available:
@ -48,9 +44,7 @@ each project.
3. "mvn clean" - deletes all temporary folders. 3. "mvn clean" - deletes all temporary folders.
-------------------- ####Basic usage
Usage
--------------------
The project can be compiled into an executable jar library: The project can be compiled into an executable jar library:
1. Execute the "mvn package" command 1. Execute the "mvn package" command
@ -76,9 +70,7 @@ IMPORTANT: if you are running the analysis using a .csv input file, please make
sure that the fields are specified in the exact order as shown above. sure that the fields are specified in the exact order as shown above.
-------------------- ####MongoDB database
MongoDB database
--------------------
There is no access control for the database, just make sure that the "bindIp" There is no access control for the database, just make sure that the "bindIp"
setting is set to "127.0.0.1" which allows only local access (typically, this setting is set to "127.0.0.1" which allows only local access (typically, this