You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/doc/userguide
Eric Leblond 315c29a8e6 ebpf: change the logic to avoid ktime usage
Kernel time is not available (and/or costly) on NIC such as
Netronome so we update the logic to detect dead flows based on a
lack of update of packets counters. This way, the XDP filter will
be usable by network card.

This patch also updates the ebpf code to support per CPU and
regular mapping. Netronome is not supporting it and the structure
is using atomic for counter so the cost of simultaneous update
is really low.

This patch also updates the xdp_filter to be able to select if the
flow table is per CPU on shared. Second option will be used for
hardward offload. To deactivate the per cpu hash, you need to set
USE_PERCPU_HASH to 0.

This patch also adds an new option to af-packet named no-percpu-hash
If this option is set to yes then the Flow bypassed manager thread
will use one CPU instead of the number of cores. By doing that
we are able to handle the case where USE_PERCPU_HASH is unset (so
hardware offload for Netronome).

This patch also remove aligment indications in the eBPF filter. This
was not really needed and it seems it is causing problem with
some recent version of LLVM toolchain.
7 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 8 years ago
_static doc: Add suricata.css to allow for some custom styling 9 years ago
capture-hardware ebpf: change the logic to avoid ktime usage 7 years ago
configuration doc: convert fancy quotes to straight quotes 7 years ago
file-extraction file-log: remove and add warning 8 years ago
licenses doc: convert fancy quotes to straight quotes 7 years ago
lua userguide: add documentation for Ja3SGetString Lua function 7 years ago
manpages doc: Add manpages for suricatasc and suricatactl 7 years ago
output userguide: add JA3S fields to the TLS logger documentation 7 years ago
partials doc: Add manpages for suricatasc and suricatactl 7 years ago
performance doc: convert fancy quotes to straight quotes 7 years ago
reputation doc: iprep supports CIDR networks 8 years ago
rule-management doc: convert fancy quotes to straight quotes 7 years ago
rules doc: convert fancy quotes to straight quotes 7 years ago
setting-up-ipsinline-for-linux
.gitignore doc: hook sphinx into build 10 years ago
Makefile.am doc/userguide: add 3rd-party-integration to dist 8 years ago
Makefile.sphinx doc: hook sphinx into build 10 years ago
README.md doc: Remove gulp references 8 years ago
acknowledgements.rst doc: Add my own name to the acknowledgements 9 years ago
command-line-options.rst doc: break out command line options into a common doc 10 years ago
conf.py doc: Add manpages for suricatasc and suricatactl 7 years ago
convert.py
index.rst doc/userguide: new 3rd party section, add bluecoat 8 years ago
initscripts.rst
install.rst doc: fix minor typo 8 years ago
make-sense-alerts.rst doc: spelling mistakes in various sections of the user guide 8 years ago
public-data-sets.rst Update public-data-sets.rst with stratosphere project 9 years ago
setting-up-ipsinline-for-linux.rst
setting-up-ipsinline-for-windows.rst Adds WinDivert support to Windows builds 8 years ago
unix-socket.rst doc: convert fancy quotes to straight quotes 7 years ago
what-is-suricata.rst doc: update what is suricata section 10 years ago

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Sphinx Document Generate is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Verifying Changes

There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).

The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.

There are different application dependencies based on the output desired.