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
Jeff Lucovsky d727271202 doc/pcre: note that flow captures need a flow
Add a note to the pcre extraction section stating that a flow: capture
is dropped when the packet is inspected without a flow, and that such a
packet still alerts.

ICMPv4 error messages are one way to get such a packet: FlowCreateCheck
returns false for them, while DecodeICMPV4 has already set p->payload,
so they reach the detection engine with something to inspect and nowhere
to store a flow variable. A packet the flow engine could not give a flow
to once the memcap was reached and no used flow could be reclaimed is
the other.

The pkt: and alert: scopes described in the same section are unaffected,
because a packet variable is stored on the packet and an alert variable
on the alert.

Issue: 8862
(cherry picked from commit c717cc1e9b)
2 months ago
..
3rd-party-integration
…
_static
…
appendix doc: adjust for master to main rename 1 year ago
capture-hardware pcap-file: skip setvbuf on non-seekable streams 4 months ago
configuration rfb: limit strings length 2 months ago
devguide devguide: add chapter about exception policies 9 months ago
file-extraction doc/file-extraction: fix highlight syntax 2 years ago
firewall fw: document config action in FW mode 2 months ago
install doc: adjust for master to main rename 1 year ago
ips doc/userguide: add ips chapter; add concept 1 year ago
licenses
…
lua ntp: expose logged fields to lua 5 months ago
manpages doc: improve manpage of suricatasc 4 months ago
output eve: add rule generation source to alert record 6 months ago
partials pcap-file: skip setvbuf on non-seekable streams 4 months ago
performance hs: prune stale MPM cache files 8 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 2 years ago
reputation
…
rule-management doc/reload: Expand rule-reload discussion 1 year ago
rules doc/pcre: note that flow captures need a flow 2 months ago
upgrade doc/upgrade: note about dns address swap on responses 1 year ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 9 months ago
Makefile.sphinx
…
README.md
…
acknowledgements.rst doc: Add missing contributors to ack file 1 year ago
command-line-options.rst
…
conf.py docs: fix deprecated inclusion of rtd theme path 1 year ago
convert.py
…
docutils.conf
…
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/userguide: add a known issues page 1 year ago
initscripts.rst
…
install.rst doc: update Rust installation instructions 2 months ago
known-issues.rst doc/userguide: add a known issues page 1 year ago
make-sense-alerts.rst
…
public-data-sets.rst doc: add more public datasets 8 months ago
quickstart.rst af-packet: remove use-mmap option 2 years ago
requirements.txt
…
security.rst doc: fix typo /var/run/suricata in file permissions docs. 1 year ago
support-status.rst
…
unix-socket.rst doc: adjust for master to main rename 1 year ago
upgrade.rst flowbits: add deprecation notice for toggle command 4 months ago
verifying-source-files.rst docs: use correct suricata version mentions 9 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.