diff --git a/README.md b/README.md index f7fe5c6..5d21bed 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

-VulnWhisperer is a vulnerability report aggregator. VulnWhisperer will pull all the reports +VulnWhisperer is a vulnerability data and report aggregator. VulnWhisperer will pull all the reports and create a file with a unique filename which is then fed into logstash. Logstash extracts data from the filename and tags all of the information inside the report (see logstash_vulnwhisp.conf file). Data is then shipped to elasticsearch to be indexed. @@ -60,6 +60,10 @@ There are a few configuration steps to setting up VulnWhisperer: * Import ElasticSearch Templates * Import Kibana Dashboards +example.ini file +

+ + Run ----- To run, fill out the configuration file with your vulnerability scanner settings. Then you can execute from the command line. diff --git a/docs/source/config_example.png b/docs/source/config_example.png new file mode 100644 index 0000000..faa7e65 Binary files /dev/null and b/docs/source/config_example.png differ