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.
1956dc3d5d
Added sections along packet-alert-max config section explaining packet alert queue overflow (when Suri reaches packet alert max), when alerts are discarded etc. Since from the user perspective it shouldn't matter how we process the alert queue, the term "replace" is used, even though there's not exactly a replacing action happening, with the queue bein pre-processed before being appended to the Packet. Also described the associated stats and added an explanation on when to change packet-alert-max. Task #5178 |
4 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| capture-hardware | 6 years ago | |
| configuration | 4 years ago | |
| devguide | 4 years ago | |
| file-extraction | 6 years ago | |
| licenses | ||
| lua | 5 years ago | |
| manpages | 5 years ago | |
| output | 5 years ago | |
| partials | 5 years ago | |
| performance | 4 years ago | |
| reputation | ||
| rule-management | 6 years ago | |
| rules | 4 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 6 years ago | |
| .gitignore | ||
| Makefile.am | 4 years ago | |
| Makefile.sphinx | ||
| README.md | 4 years ago | |
| acknowledgements.rst | ||
| command-line-options.rst | 6 years ago | |
| conf.py | 4 years ago | |
| convert.py | ||
| index.rst | 4 years ago | |
| initscripts.rst | 6 years ago | |
| install.rst | 5 years ago | |
| make-sense-alerts.rst | 6 years ago | |
| public-data-sets.rst | 5 years ago | |
| quickstart.rst | 6 years ago | |
| setting-up-ipsinline-for-linux.rst | 6 years ago | |
| setting-up-ipsinline-for-windows.rst | 6 years ago | |
| unix-socket.rst | 6 years ago | |
| upgrade.rst | 4 years ago | |
| what-is-suricata.rst | 6 years ago | |
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.