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
Shivani Bhardwaj 2b73a17bb0 detect: rename whitelist to score
The term "whitelist" is actually used to store a list of DetectPort type
items for tcp and udp in detect.h. Using the same term for also keeping
the score that affects the grouping of rules is confusing. So, rename
the variable to "score".
3 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 8 years ago
_static doc/userguide: avoid horizontal scroll on rtd 3 years ago
capture-hardware napatech: update docs to remove hba reference 3 years ago
configuration doc/userguide: document host table yaml settings 3 years ago
devguide doc/code-submission: add commit sign guide 3 years ago
file-extraction doc/userguide: spelling 3 years ago
licenses doc: convert fancy quotes to straight quotes 7 years ago
lua doc/userguide: improve SCStreamingBuffer example 3 years ago
manpages doc/userguide: spelling 3 years ago
output userguide: update tls not_after/not_before mentions 3 years ago
partials doc/userguide: add reload-tenant(s) doc 3 years ago
performance doc/userguide: update ref to installation from git 3 years ago
reputation doc: spelling 3 years ago
rule-management doc/rule-profiling: fix suricatasc typo 3 years ago
rules detect: header_lowercase transform 3 years ago
setting-up-ipsinline-for-linux
upgrade doc: document removal of unified2 6 years ago
.gitignore
Makefile.am configure: more idiomatic autoconf for sphinx-build checks 3 years ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 4 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 4 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 6 years ago
conf.py userguide: remove old css files 3 years 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
index.rst doc/userguide: display version on front page 3 years ago
initscripts.rst doc: Improve grammar, spelling and clarifications 6 years ago
install.rst userguide: add proper label to RPM install section 3 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 6 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 5 years ago
quickstart.rst doc/quickstart: add software-properties instruction 3 years ago
requirements.txt docs: adjust readthedocs config to new options 3 years ago
security.rst userguide/security: grammar fixes 3 years ago
setting-up-ipsinline-for-linux.rst doc: fix description of iptables rules 3 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 6 years ago
support-status.rst doc/support-status: add support status page 3 years ago
unix-socket.rst suricatasc: update running instructions 3 years ago
upgrade.rst detect: rename whitelist to score 3 years ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 6 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.