aboutsummaryrefslogtreecommitdiff
path: root/libraries/libprelude/README
diff options
context:
space:
mode:
authorpyllyukko <pyllyukko@maimed.org>2021-04-09 22:13:47 +0100
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2021-04-10 17:04:36 +0700
commit4e088ca04ed0bf90caa27b52c7bb37564a20a856 (patch)
tree71ee92692f85938d5c08da4d76173ee3919813bd /libraries/libprelude/README
parent9d5a89e5b7990b998e35597f8ab16598e607aaa7 (diff)
libraries/libprelude: Added (Prelude SIEM/sensor library)
Signed-off-by: Dave Woodfall <dave@slackbuilds.org> Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'libraries/libprelude/README')
-rw-r--r--libraries/libprelude/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/libraries/libprelude/README b/libraries/libprelude/README
new file mode 100644
index 0000000000000..8c948f080b9b0
--- /dev/null
+++ b/libraries/libprelude/README
@@ -0,0 +1,25 @@
+Prelude Library (https://www.prelude-siem.org)
+
+Prelude Library Overview
+========================
+
+The Prelude Library is used to make sensor developers' life better by
+providing features used by every sensor:
+
+ - Manager(s) Connection management (with fallback in case all
+ configured Managers are down, and automatic reconnection).
+
+ - Interface to communicate with the Prelude Manager.
+
+ - Asynchronous Message interface (allowing sensor to emit message
+ without blocking, even if there is latency on the wire).
+
+ - Asynchronous timer interface.
+
+ - Generic configuration API, providing a generic abstraction for
+ command-line, configuration file option, and wide option support.
+
+ - Wide option managment allowing sensor-exported options to be
+ directly accessible from the Manager administrative console.
+
+ - Generic plugin API.