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.
bdb8713ffd
The PR for the behavior change of dealing with spaces in http URI and protocol was started in 2019 and merged in 2024. When the PR was created, it belonged to the correct upgrade section, however, by the time it was merged, it was 8.0.x branch already. Move it to upgrade notes from 7 to 8 for correctness. |
3 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | 10 months ago | |
| capture-hardware | 3 months ago | |
| configuration | 3 months ago | |
| devguide | 3 months ago | |
| file-extraction | ||
| firewall | 4 months ago | |
| licenses | ||
| lua | 3 months ago | |
| manpages | 5 months ago | |
| output | 3 months ago | |
| partials | 3 months ago | |
| performance | 4 months ago | |
| plugins | 5 months ago | |
| reputation | ||
| rule-management | ||
| rules | 3 months ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 4 months ago | |
| .gitignore | 10 months ago | |
| Makefile.am | 4 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 | 4 months ago | |
| initscripts.rst | ||
| install.rst | 11 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| quickstart.rst | 5 months ago | |
| requirements.txt | ||
| security.rst | ||
| setting-up-ipsinline-for-linux.rst | 5 months ago | |
| setting-up-ipsinline-for-windows.rst | ||
| support-status.rst | ||
| unix-socket.rst | 6 months ago | |
| upgrade.rst | 3 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.