mirror of https://github.com/OISF/suricata
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.
If a Suricata inline IPS device is routing traffic over a non-encrypted tunnel, like IPv6 tunnels, packets in a flow will be dropped and not be matched. e.g. The following example is a Suricata inline IPS with an IPv6 tunnel: request: IPv4]ICMP] -> |IPS| -> IPv6]IPv4]ICMP] reply: <- |IPS| <- IPv6]IPv4]ICMP] Both the IPv4 request and IPv6 reply will be seen by Suricata on ingress. The flows will not be matched due to flow recursion level. Optionally use pkt recursion level in flow hash. Excluding recursion level in flow hash allows matching of packet flows and defrag on an inline IPS Suricata scenario where the IPS device is a tunnel terminator. Feature: 6260 |
6 months ago | |
---|---|---|
.. | ||
3rd-party-integration | ||
_static | ||
appendix | 10 months ago | |
capture-hardware | ||
configuration | 6 months ago | |
devguide | 7 months ago | |
file-extraction | 11 months ago | |
licenses | ||
lua | 6 months ago | |
manpages | ||
output | 7 months ago | |
partials | 9 months ago | |
performance | 11 months ago | |
reputation | ||
rule-management | 11 months ago | |
rules | 6 months ago | |
setting-up-ipsinline-for-linux | ||
upgrade | 10 months ago | |
.gitignore | 10 months ago | |
Makefile.am | 10 months ago | |
Makefile.sphinx | ||
README.md | ||
acknowledgements.rst | ||
command-line-options.rst | ||
conf.py | 10 months ago | |
convert.py | ||
docutils.conf | ||
generate-evedoc.sh | 10 months ago | |
index.rst | 10 months ago | |
initscripts.rst | ||
install.rst | 10 months ago | |
make-sense-alerts.rst | ||
public-data-sets.rst | 11 months ago | |
quickstart.rst | ||
requirements.txt | ||
security.rst | ||
setting-up-ipsinline-for-linux.rst | ||
setting-up-ipsinline-for-windows.rst | ||
support-status.rst | ||
unix-socket.rst | ||
upgrade.rst | 7 months ago | |
verifying-source-files.rst | ||
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.