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.
adb410fa3c
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 | 5 months ago | |
| configuration | 2 months ago | |
| devguide | 4 weeks ago | |
| file-extraction | ||
| firewall | 3 weeks ago | |
| install | ||
| ips | ||
| licenses | ||
| lua | 4 weeks ago | |
| manpages | 5 months ago | |
| output | 4 weeks ago | |
| partials | 3 weeks ago | |
| performance | 5 months ago | |
| plugins | ||
| protocols | ||
| reputation | ||
| rule-management | ||
| rules | 1 week ago | |
| upgrade | ||
| .gitignore | ||
| Makefile.am | ||
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | 2 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| quickstart.rst | 4 months ago | |
| requirements.txt | ||
| security.rst | ||
| support-status.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 4 weeks 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.