V0.1.1 Added a bit of documentation

This commit is contained in:
Christian Risi 2025-06-05 11:21:34 +02:00
parent 8a75d7c0e7
commit 725737f8c3

22
README.MD Normal file
View File

@ -0,0 +1,22 @@
# Suricata-Logger
This sofware is aimed to everyone that would like
to have interactive feedback from Suricata, like
in CTF competitions, or Threat Analyses run
independently.
## How to use it
You need to start the software with `deno run` and
then run `suricata -i insert_tap_device_here`.
> [!NOTE]
> This is ***not*** a comprehensive list on ***how to
> run Suricata***. As long as you have Suricata output
> its `eve` file like a `unix_stream` and modify the
> socket accordingly, everything should work.
> [!CAUTION]
> Since you are streaming data, be sure to ***exclude
> this traffic*** from being logged, otherwise you'll
> have a ***feedback loop***