mirror of
https://github.com/Security-Onion-Solutions/securityonion.git
synced 2026-01-04 07:13:12 +01:00
Add configuration requirements for various analyzers
This commit is contained in:
32
salt/sensoroni/files/analyzers/localfile/README.md
Normal file
32
salt/sensoroni/files/analyzers/localfile/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Localfile
|
||||
|
||||
## Description
|
||||
Utilize a local CSV file (or multiple) for associating a value to contextual data.
|
||||
|
||||
## Configuration Requirements
|
||||
|
||||
``file_path`` - Path(s) used for CSV files containing associative data. CSV files can be dropped in the analyzer directory, with ``file_path`` specified like ``mycsv.csv``.
|
||||
|
||||
- The value in the first column is used for matching
|
||||
- Header information should be supplied, as it is used for dynamically creating result sets
|
||||
- Matches will be aggregated from the provided CSV files
|
||||
|
||||
The content of the CSV file(s) should be similar to the following:
|
||||
|
||||
Ex.
|
||||
|
||||
```
|
||||
MatchValue,MatchDescription,MatchReference
|
||||
abcd1234,ThisIsADescription,https://siteabouthings.abc
|
||||
```
|
||||
|
||||
The ``file_path`` value(s) should be set in the pillar, like so:
|
||||
|
||||
```
|
||||
sensoroni:
|
||||
analyzers:
|
||||
localfile:
|
||||
file_path:
|
||||
- $file_path1
|
||||
- $file_path2
|
||||
```
|
||||
Reference in New Issue
Block a user