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 93842aa14a doc/yaml: Signal-termination option description 3 years ago
..
3rd-party-integration
_static
capture-hardware napatech: Added comment indicating that hba will be deprecated 4 years ago
configuration doc/yaml: Signal-termination option description 3 years ago
file-extraction http2: allow filestore to work with HTTP2 4 years ago
licenses
lua userguide: rename pg Lua Scripting->Lua Detection 3 years ago
manpages userguide: update references to Suricata website 3 years ago
output doc/eve-json-format/dns: Describing Z-bit 3 years ago
partials ikev1: rename ikev2 to common ike 4 years ago
performance userguide: update references to Suricata website 3 years ago
reputation
rule-management doc: Improve grammar, spelling and clarifications 5 years ago
rules userguide: update references to Suricata website 3 years ago
setting-up-ipsinline-for-linux
upgrade doc: document removal of unified2 5 years ago
.gitignore
Makefile.am doc: build all manpages 4 years ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc: update sphinx api to use add_css_file 4 years ago
convert.py
index.rst
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst pcre2: remove PCRE1 as dependency 3 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 3 years ago
quickstart.rst doc/quickstart: use new test url that works 4 years ago
setting-up-ipsinline-for-linux.rst doc: Improve grammar, spelling and clarifications 5 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
unix-socket.rst doc: fix URL for unix-socket python example 4 years ago
upgrade.rst userguide: update references to Suricata website 3 years ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 5 years ago

README.md

Suricata User Guide

This directory contains the Suricata 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.