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
Lukas Sismis adb410fa3c detect/replace: support DPDK IPS mode
The replace keyword was only enabled in the NFQ and IPFW runmodes, so in
DPDK IPS mode rules with replace only alerted without modifying
packets. DPDK packets point directly to the mbuf data, so the modified
payload and the recalculated checksums are forwarded as they are.

Enable replace for the DPDK runmode when the engine runs in IPS mode.
1 week ago
..
3rd-party-integration
…
_static
…
appendix
…
capture-hardware pcap-file: skip setvbuf on non-seekable streams 5 months ago
configuration nfs: enforce max read/write queue size and count limits 2 months ago
devguide doc: update the SSH docs for the reworked state machine 3 weeks ago
file-extraction doc: minor verbiage tweaks and reST fix 1 year ago
firewall firewall: reject flow scope for the pre-flow hook 3 weeks ago
install doc/userguide: update windivert instructions 11 months ago
ips src: doc: remove double-space typos 10 months ago
licenses
…
lua doc: update the SSH docs for the reworked state machine 3 weeks ago
manpages doc: improve manpage of suricatasc 5 months ago
output doc: update the SSH docs for the reworked state machine 3 weeks ago
partials doc: list-keywords with json output 3 weeks ago
performance http-log: remove support for http-log 5 months ago
plugins
…
protocols doc/userguide: add initial protocols overview 1 year ago
reputation
…
rule-management userguide: add references to rules/README to docs 8 months ago
rules detect/replace: support DPDK IPS mode 1 week ago
upgrade doc: upgrade notes for changes to ike output 1 year ago
.gitignore
…
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 9 months ago
Makefile.sphinx
…
README.md
…
acknowledgements.rst
…
command-line-options.rst
…
conf.py doc: address config conversion note 6 months ago
convert.py
…
docutils.conf
…
generate-evedoc.sh
…
index.rst doc/userguide: add initial protocols overview 1 year ago
initscripts.rst
…
install.rst doc: update Rust installation instructions 2 months ago
make-sense-alerts.rst
…
public-data-sets.rst doc: add more public datasets 8 months ago
quickstart.rst doc: clarify suricata.yaml location per install 4 months ago
requirements.txt
…
security.rst doc: fix typo /var/run/suricata in file permissions docs. 1 year ago
support-status.rst
…
unix-socket.rst
…
upgrade.rst doc: update the SSH docs for the reworked state machine 3 weeks ago
verifying-source-files.rst docs: use correct suricata version mentions 10 months ago
what-is-suricata.rst
…

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator 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.