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 07b7f36748 doc/reload: Expand rule-reload discussion
Clarify the resources involved in a rule reload.

Issue: 5078
2 weeks ago
..
3rd-party-integration
_static
appendix doc/userguide: add appendix item on eve schema 1 month ago
capture-hardware threading: support previous threading configuration format 2 months ago
configuration threading: support thread autopinning and interface-specific affinity 2 months ago
devguide doc/devguide: document app-layer protocol detection 4 weeks ago
file-extraction
firewall doc/ssh: document hooks 3 months ago
install doc/install: use our recommended header order 1 month ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc/lua: document request_host lua lib 2 months ago
manpages userguide/suricatactl: use suricata community page 5 months ago
output gen/typo: Misc. typo fixes 2 weeks ago
partials pcap-file: document capture method options 2 months ago
performance threading: support previous threading configuration format 2 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 4 months ago
reputation doc: spelling 2 years ago
rule-management doc/reload: Expand rule-reload discussion 2 weeks ago
rules doc/devguide: document app-layer protocol detection 4 weeks ago
setting-up-ipsinline-for-linux
upgrade doc/upgrade: note about dns address swap on responses 2 months ago
.gitignore doc/userguide: generate eve documentation 10 months ago
Makefile.am doc/install: windows build documentation 1 month ago
Makefile.sphinx
README.md
acknowledgements.rst doc: Add missing contributors to ack file 2 months ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/userguide: generate eve documentation 10 months ago
convert.py
docutils.conf
generate-evedoc.sh doc/userguide: generate eve documentation 10 months ago
index.rst doc/firewall: start of documentation 4 months ago
initscripts.rst
install.rst doc/userguide: break out package installation 1 month ago
make-sense-alerts.rst
public-data-sets.rst
quickstart.rst af-packet: remove use-mmap option 4 months ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst
setting-up-ipsinline-for-linux.rst threading: support previous threading configuration format 2 months ago
setting-up-ipsinline-for-windows.rst
support-status.rst
unix-socket.rst doc: remove python references related to suricatasc 5 months ago
upgrade.rst doc: add upgrade note about change in inspection 4 weeks ago
verifying-source-files.rst
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 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.