Update README
This commit is contained in:
29
README.md
29
README.md
@ -9,16 +9,6 @@ VulnWhisperer is a vulnerability report aggregator for nessus (more scanners to
|
||||
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.
|
||||
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
Currently supports python 2.7
|
||||
|
||||
```python
|
||||
sudo pip install -r requirements.txt
|
||||
python setup.py install
|
||||
```
|
||||
|
||||
Requirements
|
||||
-------------
|
||||
####
|
||||
@ -30,12 +20,29 @@ Requirements
|
||||
Currently Supports
|
||||
-------------
|
||||
####
|
||||
* Elasticsearch 2.x
|
||||
* Python 2.7
|
||||
* Nessus
|
||||
|
||||
|
||||
Setup
|
||||
===============
|
||||
|
||||
```python
|
||||
Install pip:
|
||||
sudo <pkg-manager> install python-pip
|
||||
sudo pip install --upgrade pip
|
||||
|
||||
Manually install requirements:
|
||||
sudo pip install pytz
|
||||
sudo pip install pandas
|
||||
|
||||
Using requirements file:
|
||||
sudo pip install -r /path/to/VulnWhisperer/requirements.txt
|
||||
|
||||
python /path/to/VulnWhisperer/setup.py install
|
||||
```
|
||||
|
||||
|
||||
Configuration
|
||||
-----
|
||||
@ -49,4 +56,4 @@ There are a few configuration steps to setting up VulnWhisperer:
|
||||
|
||||
Credit
|
||||
------
|
||||
Big thank you to <a href="https://github.com/SMAPPER">Justin Henderson</a> for his contributions to vulnWhisperer!
|
||||
Big thank you to <a href="https://github.com/SMAPPER">Justin Henderson</a> for his contributions to vulnWhisperer!
|
||||
|
Reference in New Issue
Block a user