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.
master
main-7.0.x
master-6.0.x
master-5.0.x
master-4.1.x
master-4.0.x
master-3.2.x
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 '9ef2f81ee7'
${ noResults }
suricata/doc/userguide
History
Eric Leblond 9ef2f81ee7 doc/userguide: fix typo 6 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static doc: Add suricata.css to allow for some custom styling 8 years ago
capture-hardware doc: information about scaling AF_PACKET IPS mode 6 years ago
configuration http: updates suricata.yaml comments 6 years ago
file-extraction doc/filestore(v1) - make deprecation text a note 6 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua userguide: add documentation for Ja3SGetString Lua function 6 years ago
manpages doc: Add manpages for suricatasc and suricatactl 6 years ago
output doc: document eve/dns v2 as the default 6 years ago
partials doc: cleanup enging logging 6 years ago
performance stream: remove fix stream.depth references 6 years ago
reputation userguide: remove old reference to rule-reload option 6 years ago
rule-management userguide: remove section on using Oinkmaster 6 years ago
rules doc/userguide: fix typo 6 years ago
setting-up-ipsinline-for-linux doc: rename from "sphinx" to "userguide" 9 years ago
.gitignore doc: hook sphinx into build 9 years ago
Makefile.am doc: add upgrade page 6 years ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md doc: Remove gulp references 7 years ago
acknowledgements.rst doc: Add my own name to the acknowledgements 8 years ago
command-line-options.rst doc: break out command line options into a common doc 9 years ago
conf.py doc: Add manpages for suricatasc and suricatactl 6 years ago
convert.py doc: rename from "sphinx" to "userguide" 9 years ago
index.rst doc: add upgrade page 6 years ago
initscripts.rst doc: rename from "sphinx" to "userguide" 9 years ago
install.rst doc: removal of disable-rust and path typo for suricatasc 6 years ago
make-sense-alerts.rst doc: spelling mistakes in various sections of the user guide 7 years ago
public-data-sets.rst Update public-data-sets.rst with stratosphere project 8 years ago
quickstart.rst doc: add quickstart guide 6 years ago
setting-up-ipsinline-for-linux.rst doc: reformat linux ips guide 6 years ago
setting-up-ipsinline-for-windows.rst Adds WinDivert support to Windows builds 7 years ago
unix-socket.rst doc: removal of disable-rust and path typo for suricatasc 6 years ago
upgrade.rst doc: add upgrade page 6 years ago
what-is-suricata.rst doc: update what is suricata section 9 years ago

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Sphinx Document Generate 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.