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 6afad1af51 smb/log: configuration option for types logging
suricata.yaml output section for smb now parses a types list
and will restrict logging of transactions to these types.

By default, everything still gets logged

Remove unused rs_smb_log_json_request on the way

Ticket: 7620
7 months ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
appendix doc/userguide: generate eve documentation 1 year ago
capture-hardware dpdk: document vlan stripping offload 8 months ago
configuration doc: update configuration with flow rate-tracking 8 months ago
devguide http: Use libhtp-rs. 8 months ago
file-extraction doc/file-extraction: fix highlight syntax 1 year ago
licenses
lua http: Use libhtp-rs. 8 months ago
manpages userguide/suricatactl: use suricata community page 8 months ago
output smb/log: configuration option for types logging 7 months ago
partials doc/output: EVE output buffering related settings 9 months ago
performance hyperscan: add caching mechanism for hyperscan contexts 8 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 8 months ago
reputation doc: spelling 3 years ago
rule-management userguide: expand documentation for rule profiling 1 year ago
rules doc/ftp: Add ftp.command_data 7 months ago
setting-up-ipsinline-for-linux
upgrade doc: add napatech plugin upgrade notes 1 year ago
.gitignore doc/userguide: generate eve documentation 1 year ago
Makefile.am doc/ndpi: move ndpi docs to new plugins section 8 months ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 4 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst
conf.py doc/userguide: generate eve documentation 1 year 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
generate-evedoc.sh doc/userguide: generate eve documentation 1 year ago
index.rst doc/ndpi: move ndpi docs to new plugins section 8 months ago
initscripts.rst
install.rst docs: remove mentions to Suricata-6 1 year ago
make-sense-alerts.rst
public-data-sets.rst userguide: update Security Onion docs reference 1 year ago
quickstart.rst af-packet: remove use-mmap option 8 months ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst userguide/security: grammar fixes 2 years ago
setting-up-ipsinline-for-linux.rst af-packet: remove use-mmap option 8 months ago
setting-up-ipsinline-for-windows.rst
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst doc: remove python references related to suricatasc 9 months ago
upgrade.rst http: Use libhtp-rs. 8 months ago
verifying-source-files.rst doc: add source verification docs 1 year 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.