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.
suricata/doc/userguide
Shivani Bhardwaj 899eb38691 flowbits: deprecate toggle command
toggle command is not used by any major rulesets and increases the state
complexity of flowbits management. Also, all operations can be carried
out with the combination of other available commands. So, remove it.

Task 8595
1 month ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 3 years ago
appendix doc: adjust for master to main rename 10 months ago
capture-hardware doc: minor ebpf doc update for fedora/rhel 1 month ago
configuration doc/firewall: update hooks & configuration examples 1 month ago
devguide http2: split progress per direction 1 month ago
file-extraction doc: minor verbiage tweaks and reST fix 9 months ago
firewall doc/firewall: update hooks & configuration examples 1 month ago
install doc/userguide: update windivert instructions 7 months ago
ips src: doc: remove double-space typos 6 months ago
licenses
lua http-log: remove support for http-log 1 month ago
manpages doc: improve manpage of suricatasc 2 months ago
output doc: dhcp eve note for option 52 overload 1 month ago
partials ntp: add transaction logging 3 months ago
performance http-log: remove support for http-log 1 month ago
plugins doc/ndpi: move ndpi docs to new plugins section 1 year ago
protocols doc/userguide: add initial protocols overview 10 months ago
reputation doc: spelling 3 years ago
rule-management userguide: add references to rules/README to docs 4 months ago
rules flowbits: deprecate toggle command 1 month ago
upgrade doc: upgrade notes for changes to ike output 9 months ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 5 months ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 4 years ago
acknowledgements.rst doc: Add missing contributors to ack file 1 year ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 6 years ago
conf.py doc: address config conversion note 2 months ago
convert.py doc/optimization: move "convert.py" to Python3 3 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 3 years ago
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/userguide: add initial protocols overview 10 months ago
initscripts.rst doc: Improve grammar, spelling and clarifications 6 years ago
install.rst docs: use correct suricata version mentions 6 months ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 6 years ago
public-data-sets.rst doc: add more public datasets 5 months ago
quickstart.rst doc: move more rules to dedicated css container 3 months ago
requirements.txt docs: adjust readthedocs config to new options 3 years ago
security.rst doc: fix typo /var/run/suricata in file permissions docs. 10 months ago
support-status.rst devguide: make 'contributing' a chapter 3 years ago
unix-socket.rst doc: adjust for master to main rename 10 months ago
upgrade.rst flowbits: deprecate toggle command 1 month ago
verifying-source-files.rst docs: use correct suricata version mentions 6 months ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 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.