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
Jason Ish 35b03b4077 lua: convert flowvar functions to lib
New Lua lib, "suricata.flowvar" for working with flowvars from Lua.

Replaces functions:
- SCFlowvarGet (and ScFlowvarGet)
- SCFlowvarSet (and SCFlowvarSet)

Of note, the DetectLuaData has been made available to the init and
thread_init methods, instead of just the match. This is due to an
issue that if a flow variable is not registered in init, it will not
be logged, registering in thread_init is too late.

Ticket: #7486
1 year ago
..
3rd-party-integration
_static
appendix doc/userguide: generate eve documentation 2 years ago
capture-hardware dpdk: document vlan stripping offload 1 year ago
configuration lua: enable lua rules by default 1 year ago
devguide plugin: document app-layer plugins 1 year ago
file-extraction doc/file-extraction: fix highlight syntax 2 years ago
firewall doc/ssh: document hooks 1 year ago
licenses
lua lua: convert flowvar functions to lib 1 year ago
manpages userguide/suricatactl: use suricata community page 1 year ago
output dox/userguide: add tx_cnt documentation 1 year ago
partials doc/output: EVE output buffering related settings 1 year ago
performance doc: stylistic and grammar fixes 1 year ago
plugins doc/ndpi: move ndpi docs to new plugins section 1 year ago
reputation
rule-management userguide: expand documentation for rule profiling 2 years ago
rules doc/ssh: document hooks 1 year ago
setting-up-ipsinline-for-linux
upgrade doc/userguide: type in pfring upgrade notes 1 year ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am doc/firewall: start of documentation 1 year ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py doc/userguide: generate eve documentation 2 years ago
convert.py
docutils.conf
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/firewall: start of documentation 1 year ago
initscripts.rst
install.rst docs: remove mentions to Suricata-6 2 years ago
make-sense-alerts.rst
public-data-sets.rst userguide: update Security Onion docs reference 2 years ago
quickstart.rst af-packet: remove use-mmap option 1 year ago
requirements.txt docs: adjust readthedocs config to new options 3 years ago
security.rst
setting-up-ipsinline-for-linux.rst af-packet: remove use-mmap option 1 year ago
setting-up-ipsinline-for-windows.rst
support-status.rst devguide: make 'contributing' a chapter 3 years ago
unix-socket.rst doc: remove python references related to suricatasc 1 year ago
upgrade.rst stream: decouple stream.bypass dependency from tls bypass 1 year ago
verifying-source-files.rst doc: add source verification docs 2 years ago
what-is-suricata.rst

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.