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 ed2a81dc05 doc/entropy: Add documentation for the entropy keyword
This commits adds documentation for the entropy keyword.
The entropy keyword calculates the Shannon entropy value for content
with the calculated value used to determine whether an alert occurs.
3 months ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
appendix doc/userguide: generate eve documentation 9 months ago
capture-hardware dpdk: document vlan stripping offload 3 months ago
configuration doc/exceptions: change stats counters names 3 months ago
devguide userguide: explain rule types and categorization 5 months ago
file-extraction doc/file-extraction: fix highlight syntax 10 months ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc: add http library supported fns 3 months ago
manpages userguide/suricatactl: use suricata community page 4 months ago
output flow/output: log triggered exception policies 4 months ago
partials doc/output: EVE output buffering related settings 4 months ago
performance hyperscan: add caching mechanism for hyperscan contexts 3 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 3 months ago
reputation doc: spelling 2 years ago
rule-management userguide: expand documentation for rule profiling 10 months ago
rules doc/entropy: Add documentation for the entropy keyword 3 months ago
setting-up-ipsinline-for-linux doc: rename from "sphinx" to "userguide" 9 years ago
upgrade doc: add napatech plugin upgrade notes 9 months ago
.gitignore doc/userguide: generate eve documentation 9 months ago
Makefile.am doc/ndpi: move ndpi docs to new plugins section 3 months ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/userguide: generate eve documentation 9 months 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
generate-evedoc.sh doc/userguide: generate eve documentation 9 months ago
index.rst doc/ndpi: move ndpi docs to new plugins section 3 months ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst docs: remove mentions to Suricata-6 9 months ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update Security Onion docs reference 10 months ago
quickstart.rst af-packet: remove use-mmap option 3 months 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 af-packet: remove use-mmap option 3 months ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
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 dpdk: check for link up before full startup 3 months ago
verifying-source-files.rst doc: add source verification docs 1 year 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 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.