Skip to content

Commit

Permalink
Add installation section to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bobkarreman committed Oct 15, 2024
1 parent 83dbb1c commit 197220b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@ Provides sourcetyping for ingestion and processing of dissect records.
## Prerequisites and dependencies
When ingested Dissect output contains Evtx records they are correctly interpreted according to CIM if the Splunk Windows TA is installed.
To achieve this, the XmlWinEventLog of the Windows TA is altered to perform KV_MODE field extractions.
Therefor, be carefull to use this app in a production monitoring environment.
Therefore, be carefull to use this app in a production monitoring environment.

App dependencies:
- Splunk Windows TA

## Installation
The latest verion can be downloaded and installed directly from [Splunkbase](https://splunkbase.splunk.com/app/7580).
Alternatively it can be downloaded from the Releases page on [Github](https://github.com/fox-it/dissect-add-on-for-splunk/releases).

## Usage
Most basic usage is to create a tcp input in Splunk and configure it with the wanted dissect sourcetype.
You can now use rdump from the Dissect suite to push data to the Splunk server tcp port. See Dissect documentation on how to use rdump.
Expand Down

0 comments on commit 197220b

Please sign in to comment.