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.
fa695d3563
The firewall userguide pages still described the old TLS completion milestones, and an upgrade from the old state names had no guidance. Update the firewall design and example pages to the phase names, list the migration page in the firewall index, and add the migration page itself: the old/new state name mapping, the load-time validation of rules and config keys, monitoring of ts_progress, and the semantic changes - the fragmented hello decision, the removed flight-completion state, one decision per state, the new ja3/ja3s event timing, and the SSLv2 track behaviour. The 9.0.0 upgrade guide gains Major Changes (a rule with an old state name fails to load and is not enforced; config keys renamed) and Logging Changes (ts_progress/tc_progress values) entries, both linking the migration page. Ticket: #9047. |
3 weeks ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | 1 year ago | |
| capture-hardware | 5 months ago | |
| configuration | 1 month ago | |
| devguide | 3 weeks ago | |
| file-extraction | 1 year ago | |
| firewall | 3 weeks ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 5 months ago | |
| manpages | 5 months ago | |
| output | 2 months ago | |
| partials | 5 months ago | |
| performance | 5 months ago | |
| plugins | ||
| protocols | 1 year ago | |
| reputation | ||
| rule-management | 8 months ago | |
| rules | 4 weeks ago | |
| upgrade | 1 year ago | |
| .gitignore | ||
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | 1 year ago | |
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | 1 year ago | |
| initscripts.rst | ||
| install.rst | 2 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 8 months ago | |
| quickstart.rst | 4 months ago | |
| requirements.txt | ||
| security.rst | 1 year ago | |
| support-status.rst | ||
| unix-socket.rst | 1 year ago | |
| upgrade.rst | 3 weeks ago | |
| verifying-source-files.rst | 10 months ago | |
| 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.