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
Philippe Antoine e3105a6614 ftp: adds a config option ftp-hash for autofp-scheduler
This allows ftp-data and ftp flows to be processed by the same
thread. Otherwise, there may be a concurrency issue where the
would-be ftp-data flow is first processed, and thus not recognized
as such. And the ftp flow gets processed later and the expectation
coming from it is never found.

To do so, the flow hash gets used as usual, except for flows that
may be either ftp or ftp-data, that is either one port is 21, or
both ports are high ones.

Ticket: #5205
3 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 7 years ago
_static doc: Add suricata.css to allow for some custom styling 8 years ago
capture-hardware doc: document AF_XDP feature 3 years ago
configuration dcerpc: config limit maximum number of live transactions 3 years ago
devguide devguide/install: add note about ubuntu version 3 years ago
file-extraction http2: allow filestore to work with HTTP2 5 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc: Document SCByteVarGet lua function 3 years ago
manpages userguide: update references to Suricata website 4 years ago
output doc/userguide: update bittorrent-dht eve examples 3 years ago
partials doc/userguide: document --include command line option 3 years ago
performance ftp: adds a config option ftp-hash for autofp-scheduler 3 years ago
reputation userguide: remove old reference to rule-reload option 6 years ago
rule-management doc: Improve grammar, spelling and clarifications 5 years ago
rules userguide: update http.cookie description 3 years ago
setting-up-ipsinline-for-linux doc: rename from "sphinx" to "userguide" 9 years ago
upgrade doc: document removal of unified2 5 years ago
.gitignore doc: hook sphinx into build 9 years ago
Makefile.am devguide: drop use of mscgen script in builds/make 3 years ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/conf: fix sphinx language setting 3 years ago
convert.py doc: rename from "sphinx" to "userguide" 9 years ago
index.rst devguide: move into userguide as last chapter 3 years ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst doc/userguide: ubuntu: install software-properties-common 3 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 4 years ago
quickstart.rst devguide: add page on installing suricata from git 3 years ago
setting-up-ipsinline-for-linux.rst doc/netmap: Describe Netmap IPS usage 3 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
unix-socket.rst doc: fix URL for unix-socket python example 5 years ago
upgrade.rst exceptions: add master switch config option 3 years 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.