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-8.0.x
main-7.0.x
main
master-6.0.x
master-5.0.x
master-4.1.x
master-4.0.x
master-3.2.x
suricata-8.0.2
suricata-7.0.13
suricata-8.0.1
suricata-7.0.12
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 'a1c4167d94'
${ noResults }
suricata/doc/userguide
History
Victor Julien a1c4167d94 doc/userguide: add initial protocols overview 
Explain per protocol mechanics for rule matching.
 		2 months ago
..
3rd-party-integration
…
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
appendix doc: adjust for master to main rename 2 months ago
capture-hardware doc/dpdK: update RX/TX descriptor note for Connect-X 4 3 months ago
configuration doc: fix doc syntax error in rate_filter example. 2 months ago
devguide doc/userguide: add initial protocols overview 2 months ago
file-extraction doc/file-extraction: fix highlight syntax 1 year ago
firewall doc/userguide: add ips chapter; add concept 2 months ago
install doc: adjust for master to main rename 2 months ago
ips doc/userguide: add ips chapter; add concept 2 months ago
licenses doc: convert fancy quotes to straight quotes 7 years ago
lua doc/lualib: fix wrong tuple section markdown in flowlib 3 months ago
manpages userguide/suricatactl: use suricata community page 8 months ago
output doc/fileinfo: Document fileinfo context/usage 2 months ago
partials doc/suricatasc: Mentioned get-flow-stats-by-id cmd 4 months ago
performance threading: support previous threading configuration format 5 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 8 months ago
protocols doc/userguide: add initial protocols overview 2 months ago
reputation doc: spelling 3 years ago
rule-management doc/reload: Expand rule-reload discussion 4 months ago
rules doc/userguide: add initial protocols overview 2 months ago
upgrade doc/upgrade: note about dns address swap on responses 5 months ago
.gitignore doc/userguide: generate eve documentation 1 year ago
Makefile.am doc/userguide: add initial protocols overview 2 months ago
Makefile.sphinx
…
README.md devguide: move into userguide as last chapter 4 years ago
acknowledgements.rst doc: Add missing contributors to ack file 5 months ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py docs: fix deprecated inclusion of rtd theme path 3 months ago
convert.py doc/optimization: move "convert.py" to Python3 3 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 3 years ago
generate-evedoc.sh doc/userguide: generate eve documentation 1 year ago
index.rst doc/userguide: add initial protocols overview 2 months ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst doc/install: remove reference to --enable-lua 4 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 1 year ago
quickstart.rst af-packet: remove use-mmap option 8 months ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst doc: fix typo /var/run/suricata in file permissions docs. 2 months ago
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst doc: adjust for master to main rename 2 months ago
upgrade.rst doc: upgrade note about keyword tls.cert_subject 2 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.