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.
6ae5ae701b
Add EVE documentation for QUIC and Pgsql to their respective sections of the userguide. Also add a complete EVE reference as an appendix. Other protocols can be done, but its a manual process to document in the schema, then add the glue to pull them into the documentation. The documentation is generated during "make dist", or if it doesn't exist, "conf.py" will attempt to generate the eve documentation for building on Readthedocs. |
2 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | 3 years ago | |
| appendix | 2 years ago | |
| capture-hardware | 2 years ago | |
| configuration | 2 years ago | |
| devguide | 2 years ago | |
| file-extraction | 2 years ago | |
| licenses | ||
| lua | 3 years ago | |
| manpages | 3 years ago | |
| output | 2 years ago | |
| partials | 2 years ago | |
| performance | 2 years ago | |
| reputation | 3 years ago | |
| rule-management | 2 years ago | |
| rules | 2 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 2 years ago | |
| .gitignore | 2 years ago | |
| Makefile.am | 2 years ago | |
| Makefile.sphinx | ||
| README.md | 4 years ago | |
| acknowledgements.rst | 4 years ago | |
| command-line-options.rst | 6 years ago | |
| conf.py | 2 years ago | |
| convert.py | 3 years ago | |
| docutils.conf | 3 years ago | |
| generate-evedoc.sh | 2 years ago | |
| index.rst | 2 years ago | |
| initscripts.rst | 6 years ago | |
| install.rst | 2 years ago | |
| make-sense-alerts.rst | 6 years ago | |
| public-data-sets.rst | 2 years ago | |
| quickstart.rst | 3 years ago | |
| requirements.txt | 3 years ago | |
| security.rst | 3 years ago | |
| setting-up-ipsinline-for-linux.rst | 3 years ago | |
| setting-up-ipsinline-for-windows.rst | 6 years ago | |
| support-status.rst | 3 years ago | |
| unix-socket.rst | 3 years ago | |
| upgrade.rst | 2 years ago | |
| verifying-source-files.rst | 2 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.