]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
devguide: add chapter and short intro to libsuricata
authorJuliana Fajardini <jufajardini@oisf.net>
Mon, 4 Mar 2024 16:12:08 +0000 (13:12 -0300)
committerVictor Julien <victor@inliniac.net>
Sat, 9 Mar 2024 06:54:41 +0000 (07:54 +0100)
With this, we intend to make more users aware of this use case, and that
we are working towards this.

Related to
Task #2693

doc/userguide/devguide/index.rst
doc/userguide/devguide/libsuricata/index.rst [new file with mode: 0644]

index 26a83497114fbb8051c281751036fe9ab30cfe43..9393af8b320904251512ad284e26e940033fca04 100644 (file)
@@ -8,3 +8,4 @@ Suricata Developer Guide
    contributing/index.rst
    internals/index.rst
    extending/index.rst
+   libsuricata/index.rst
diff --git a/doc/userguide/devguide/libsuricata/index.rst b/doc/userguide/devguide/libsuricata/index.rst
new file mode 100644 (file)
index 0000000..d0c58c2
--- /dev/null
@@ -0,0 +1,14 @@
+.. _libsuricata:
+
+LibSuricata
+===========
+
+Using Suricata as a Library
+---------------------------
+
+The ability to turn Suricata into a library that can be utilized in other tools
+is currently a work in progress, tracked by Redmine Ticket #2693:
+https://redmine.openinfosecfoundation.org/issues/2693.
+
+A related work are Suricata plugins, also in progress and tracked by Redmine
+Ticket #4101: https://redmine.openinfosecfoundation.org/issues/4101.