aiden
/
suricata
mirror of https://github.com/OISF/suricata
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
main-7.0.x
master
master-6.0.x
master-5.0.x
master-4.1.x
master-4.0.x
master-3.2.x
suricata-8.0.0
suricata-7.0.11
suricata-8.0.0-rc1
suricata-8.0.0-beta1
suricata-7.0.10
suricata-7.0.9
suricata-7.0.8
suricata-7.0.7
suricata-7.0.6
suricata-6.0.20
suricata-7.0.5
suricata-6.0.19
suricata-6.0.18
suricata-7.0.4
suricata-6.0.17
suricata-7.0.3
suricata-6.0.16
suricata-7.0.2
suricata-6.0.15
suricata-7.0.1
suricata-6.0.14
suricata-7.0.0
suricata-7.0.0-rc2
suricata-6.0.13
suricata-6.0.12
suricata-6.0.11
suricata-7.0.0-rc1
suricata-6.0.10
suricata-6.0.9
suricata-7.0.0-beta1
suricata-6.0.8
suricata-6.0.7
suricata-6.0.6
suricata-5.0.10
suricata-6.0.5
suricata-5.0.9
suricata-6.0.4
suricata-5.0.8
suricata-6.0.3
suricata-5.0.7
suricata-6.0.2
suricata-5.0.6
suricata-6.0.1
suricata-5.0.5
suricata-4.1.10
suricata-4.1.9
suricata-5.0.4
suricata-6.0.0
suricata-6.0.0-rc1
suricata-6.0.0-beta1
suricata-5.0.3
suricata-4.1.8
suricata-4.1.7
suricata-5.0.2
suricata-4.1.6
suricata-5.0.1
suricata-5.0.0
suricata-5.0.0-rc1
suricata-4.1.5
suricata-5.0.0-beta1
suricata-4.1.4
suricata-4.1.3
suricata-4.0.7
suricata-4.1.2
suricata-4.1.1
suricata-4.1.0
suricata-4.0.6
suricata-4.1.0-rc2
suricata-4.1.0-rc1
suricata-4.0.5
suricata-4.1.0-beta1
suricata-4.0.4
suricata-4.0.3
suricata-4.0.2
suricata-3.2.5
suricata-4.0.1
suricata-3.2.4
suricata-4.0.0
suricata-4.0.0-rc2
suricata-3.2.3
suricata-4.0.0-rc1
suricata-4.0.0-beta1
suricata-3.2.2
suricata-3.1.4
suricata-3.2.1
suricata-3.2
suricata-3.2RC1
suricata-3.1.3
suricata-3.2beta1
suricata-3.1.2
suricata-3.1.1
suricata-3.1
suricata-3.0.2
suricata-3.1RC1
suricata-3.0.1
suricata-3.0.1RC1
suricata-3.0
suricata-2.0.11
suricata-3.0RC3
suricata-3.0RC2
suricata-3.0RC1
suricata-2.0.10
suricata-2.0.9
suricata-2.1beta4
suricata-2.0.8
suricata-2.0.7
suricata-2.1beta3
suricata-2.0.6
suricata-2.0.5
suricata-2.1beta2
suricata-2.0.4
suricata-2.1beta1
suricata-2.0.3
suricata-2.0.2
suricata-2.0.1
suricata-2.0.1rc1
suricata-2.0
suricata-2.0rc3
suricata-2.0rc2
suricata-2.0rc1
suricata-2.0beta2
suricata-1.4.7
suricata-1.4.6
suricata-1.4.5
suricata-2.0beta1
suricata-1.4.4
suricata-1.4.3
suricata-1.4.2
suricata-1.4.1
suricata-1.3.6
suricata-1.4
suricata-1.3.5
suricata-1.4rc1
suricata-1.3.4
suricata-1.4beta3
suricata-1.3.3
suricata-1.4beta2
suricata-1.3.2
suricata-1.4beta1
suricata-1.3.1
suricata-1.3
suricata-1.3rc1
suricata-1.3beta2
suricata-1.3beta1
suricata-1.2.1
suricata-1.2
suricata-1.2rc1
suricata-1.2beta1
suricata-1.1.1
suricata-0.8.2
suricata-1.0.0
suricata-1.0.1
suricata-1.0.2
suricata-1.0.3
suricata-1.0.4
suricata-1.0.5
suricata-1.1
suricata-1.1beta1
suricata-1.1beta2
suricata-1.1beta3
suricata-1.1rc1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b93a27722c'
${ noResults }
suricata/doc/userguide
History
Juliana Fajardini a8453d73cd detect: remove unused non-pf stats counters 
Remove unused rule prefilter-related stats counters that aren't in use.

94644ac960 (detect: move non-pf rules into special prefilter engines)
removed the logic that made use of and incremented the stats counters:
- det_ctx->counter_fnonmpm_list
- det_ctx->counter_nonmpm_list

Some code was left, registering them, and mentioning them in the
json schema.

Ticket #7834
 		2 weeks ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 7 years ago
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
appendix doc/userguide: add appendix item on eve schema 2 months ago
capture-hardware doc/dpdK: update RX/TX descriptor note for Connect-X 4 2 weeks ago
configuration threading: support thread autopinning and interface-specific affinity 2 months ago
devguide doc/devguide: document app-layer protocol detection 2 months ago
file-extraction doc/file-extraction: fix highlight syntax 12 months ago
firewall doc/lua-functions: update lua-function documentation 2 weeks ago
install doc/install: use our recommended header order 2 months ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua lua: document the dnp3 lib 2 weeks ago
manpages
…
output doc/lua-output: fix example script for new apis 2 weeks ago
partials doc/suricatasc: Mentioned get-flow-stats-by-id cmd 2 weeks ago
performance threading: support previous threading configuration format 2 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 5 months ago
reputation doc: spelling 2 years ago
rule-management doc/reload: Expand rule-reload discussion 1 month ago
rules doc/lua-detection: fix example script; remove most buffers 2 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 2 months 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
…
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
…
index.rst doc/firewall: start of documentation 4 months ago
initscripts.rst
…
install.rst doc/install: remove reference to --enable-lua 2 weeks ago
make-sense-alerts.rst
…
public-data-sets.rst userguide: update Security Onion docs reference 12 months ago
quickstart.rst
…
requirements.txt
…
security.rst
…
setting-up-ipsinline-for-linux.rst threading: support previous threading configuration format 2 months ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
support-status.rst
…
unix-socket.rst doc/suricatasc: Mentioned get-flow-stats-by-id cmd 2 weeks ago
upgrade.rst detect: remove unused non-pf stats counters 2 weeks 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.