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-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 'dfae19247d'
${ noResults }
suricata/doc/userguide
History
Ralph Broenink dfae19247d doc: Completely rewrite the rules introduction for more clearity 7 years ago
..
_static doc: Add suricata.css to allow for some custom styling 7 years ago
capture-hardware doc/napatech: formatting fixes 8 years ago
configuration rate_filter by_both through IPPair storage 7 years ago
file-extraction Adds options to mark when a file is final. 7 years ago
licenses doc: add GPL and CC licenses 9 years ago
manpages doc: manpage: add bugs and notes section 9 years ago
output redis: support for rpush in list mode 8 years ago
partials doc: break out command line options into a common doc 9 years ago
performance doc: expand on bpf 8 years ago
reputation docs: fix statement about flow:to_server 8 years ago
rule-management doc: move rule reload and adding rules into rule-management 9 years ago
rules doc: Completely rewrite the rules introduction for more clearity 7 years ago
setting-up-ipsinline-for-linux
…
.gitignore doc: hook sphinx into build 9 years ago
Makefile.am doc: only build pdf on dist if pdflatex is installed 8 years ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md
…
acknowledgements.rst
…
command-line-options.rst doc: break out command line options into a common doc 9 years ago
conf.py doc: Add suricata.css to allow for some custom styling 7 years ago
convert.py
…
index.rst doc: add rule-management chapter 9 years ago
initscripts.rst
…
install.rst doc: add rust and update version in install 8 years ago
make-sense-alerts.rst
…
public-data-sets.rst Update public-data-sets.rst with stratosphere project 8 years ago
setting-up-ipsinline-for-linux.rst
…
unix-socket.rst doc: update unix socket 8 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.

Development Server

To help with writing documentation there is a development web server with live reload. To get run the live server you will first need npm installed then run the following:

npm install
gulp serve

Then point your browser at http://localhost:8000/_build/html/index.html

Any edits to .rst files should trigger a "make html" and cause your browser to refresh.