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
Victor Julien 55b4c1e6fd stream: mark urgent experimental; set safe defaults
Uncomment in default config. This will make the policy "inline",
which is the same behavior as prior to the urgent policy support.

Add line to docs that this is an experimental feature.
8 months ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
capture-hardware doc: update eBPF compilation instructions 1 year ago
configuration stream: mark urgent experimental; set safe defaults 8 months ago
devguide doc/code-submission: add commit sign guide 2 years ago
file-extraction doc/userguide: spelling 2 years ago
licenses
lua doc/userguide: improve SCStreamingBuffer example 2 years ago
manpages doc/userguide: spelling 2 years ago
output doc: improve documentation about guess-applayer-tx 8 months ago
partials output/ja4: Log ja4 hashes iff configured 1 year ago
performance doc/userguide: update ref to installation from git 2 years ago
reputation doc: spelling 2 years ago
rule-management doc/rule-profiling: fix suricatasc typo 2 years ago
rules flowint: add isnotset support 8 months ago
setting-up-ipsinline-for-linux
upgrade
.gitignore
Makefile.am doc: add source verification docs 1 year ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py docs/userguide: use a consistent date for reproducible builds 1 year ago
convert.py doc/optimization: move "convert.py" to Python3 2 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 2 years ago
index.rst doc: add source verification docs 1 year ago
initscripts.rst
install.rst doc: port user install and build instruction from master-6.0.x 1 year ago
make-sense-alerts.rst
public-data-sets.rst
quickstart.rst doc/quickstart: add software-properties instruction 2 years ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst userguide/security: grammar fixes 2 years ago
setting-up-ipsinline-for-linux.rst doc: fix description of iptables rules 2 years ago
setting-up-ipsinline-for-windows.rst
support-status.rst doc/support-status: add support status page 2 years ago
unix-socket.rst suricatasc: update running instructions 2 years ago
upgrade.rst doc: improve documentation about guess-applayer-tx 8 months ago
verifying-source-files.rst doc: add source verification docs 1 year 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.