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 6f5fd77cb9 detect/app-layer-state: keyword for protocol state
Allow matching on the app-layer protocol state.
1 year ago
..
3rd-party-integration
_static
appendix doc/userguide: generate eve documentation 2 years ago
capture-hardware dpdk: document vlan stripping offload 1 year ago
configuration pcap-log: add bpf filter for packets that are logged 1 year ago
devguide http: Use libhtp-rs. 1 year ago
file-extraction
licenses
lua http: Use libhtp-rs. 1 year ago
manpages userguide/suricatactl: use suricata community page 1 year ago
output output: option to add suricata version in eve logs 1 year ago
partials doc/output: EVE output buffering related settings 1 year ago
performance doc: stylistic and grammar fixes 1 year ago
plugins doc/ndpi: move ndpi docs to new plugins section 1 year ago
reputation
rule-management
rules detect/app-layer-state: keyword for protocol state 1 year ago
setting-up-ipsinline-for-linux
upgrade doc: add napatech plugin upgrade notes 2 years ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am doc/ndpi: move ndpi docs to new plugins section 1 year ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py doc/userguide: generate eve documentation 2 years ago
convert.py
docutils.conf
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/ndpi: move ndpi docs to new plugins section 1 year ago
initscripts.rst
install.rst
make-sense-alerts.rst
public-data-sets.rst
quickstart.rst af-packet: remove use-mmap option 1 year ago
requirements.txt
security.rst
setting-up-ipsinline-for-linux.rst af-packet: remove use-mmap option 1 year ago
setting-up-ipsinline-for-windows.rst
support-status.rst
unix-socket.rst doc: remove python references related to suricatasc 1 year ago
upgrade.rst stream: decouple stream.bypass dependency from tls bypass 1 year 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.