Docbook: Update the Logwolf quick start.

Fix some spelling errors and paths.
This commit is contained in:
Gerald Combs 2022-04-04 12:16:59 -07:00 committed by A Wireshark GitLab Utility
parent 330d408328
commit a212b86222
1 changed files with 8 additions and 7 deletions

View File

@ -1,6 +1,7 @@
= Logwolf Quick Start
Logwolf is a sibling application for Wireshark which focuses on log messages. It helps people understand, troubleshoot, and secure their systems via log messagess similar to the way Wireshark helps people understand, troubleshoot, and secure their networks via packets.
Logwolf is a sibling application for Wireshark which focuses on log messages.
It helps people understand, troubleshoot, and secure their systems via log messages similar to the way Wireshark helps people understand, troubleshoot, and secure their networks via packets.
This document provides brief instructions for building Logwolf until more complete documentation comparable to the Wireshark Developers and Users Guides can be written.
@ -9,7 +10,7 @@ This document provides brief instructions for building Logwolf until more comple
Logwolf requires the same build environment as Wireshark.
See the https://www.wireshark.org/docs/wsdg_html_chunked/[Wireshark Developers Guide] for instructions on setting that up.
It additonally requires libsinsp and libscap from https://github.com/falcosecurity/libs/[falcosecurity/libs] and any desired plugins from https://github.com/falcosecurity/plugins/[falcosecurity/plugins].
It additionally requires libsinsp and libscap from https://github.com/falcosecurity/libs/[falcosecurity/libs] and any desired plugins from https://github.com/falcosecurity/plugins/[falcosecurity/plugins].
In order to build Logwolf, do the following:
@ -26,7 +27,7 @@ SINSP_INCLUDEDIR:: The path to your local falcosecurity/libs directory
SINSP_LIBDIR:: The path to your falcosecurity/libs build directory
--
4. Create a directory named `sysdig` in you Logwolf plugins directory, and either copy in or symlink any desired Falco plugins.
4. Create a directory named `falco` in your Logwolf plugins directory, and either copy in or symlink any desired Falco plugins.
.Example 1: Building on macOS using Ninja
[sh]
@ -37,8 +38,8 @@ cmake -G Ninja \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
ninja
mkdir run/Logwolf.app/Contents/PlugIns/sysdig
(cd run/Logwolf.app/Contents/PlugIns/sysdig ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
mkdir run/Logwolf.app/Contents/PlugIns/logwolf/3-7/falco
(cd run/Logwolf.app/Contents/PlugIns/logwolf/3-7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
----
.Example 2: Building on Linux using Make
@ -50,7 +51,7 @@ cmake \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
make -j $(getconf _NPROCESSORS_ONLN)
mkdir run/plugins/sysdig
(cd run/plugins/sysdig ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
mkdir run/plugins/3.7/falco
(cd run/plugins/3.7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
----