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
Jeff Lucovsky aec2513799 doc/ftp: Document ftp.reply_received
Add documentation for the ftp.reply_received keyword.
2 months ago
..
3rd-party-integration
_static
appendix doc/userguide: generate eve documentation 9 months ago
capture-hardware dpdk: document vlan stripping offload 3 months ago
configuration lua: enable lua rules by default 3 months ago
devguide doc/devguide: document the rate filter callback 2 months ago
file-extraction doc/file-extraction: fix highlight syntax 10 months ago
firewall doc/ssh: document hooks 2 months ago
licenses
lua lua: better doc for ja3 lib 2 months ago
manpages userguide/suricatactl: use suricata community page 4 months ago
output output/tls: Allow logging of sv-handshake params 2 months ago
partials doc/output: EVE output buffering related settings 4 months ago
performance doc: stylistic and grammar fixes 3 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 3 months ago
reputation
rule-management userguide: expand documentation for rule profiling 10 months ago
rules doc/ftp: Document ftp.reply_received 2 months ago
setting-up-ipsinline-for-linux
upgrade doc/userguide: type in pfring upgrade notes 3 months ago
.gitignore doc/userguide: generate eve documentation 9 months ago
Makefile.am doc/firewall: start of documentation 3 months ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py doc/userguide: generate eve documentation 9 months ago
convert.py
docutils.conf
generate-evedoc.sh doc/userguide: generate eve documentation 9 months ago
index.rst doc/firewall: start of documentation 3 months ago
initscripts.rst
install.rst docs: remove mentions to Suricata-6 9 months ago
make-sense-alerts.rst
public-data-sets.rst userguide: update Security Onion docs reference 10 months ago
quickstart.rst af-packet: remove use-mmap option 4 months ago
requirements.txt
security.rst
setting-up-ipsinline-for-linux.rst af-packet: remove use-mmap option 4 months ago
setting-up-ipsinline-for-windows.rst
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst doc: remove python references related to suricatasc 4 months ago
upgrade.rst stream: decouple stream.bypass dependency from tls bypass 3 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.