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
tlhsec 10919e1835 eve/mdns: add requests and responses config flags
The mDNS EVE logger previously logged every transaction unconditionally,
with a TODO noting that request/response-only flags would be useful
(mirroring the existing eve-log.dns logger). This resolves that TODO by
adding "requests" and "responses" configuration keys to eve-log.mdns.

Both default to enabled, preserving the current behavior of logging all
mDNS traffic. Setting either to "no" skips the corresponding
transactions before allocating the JSON builder, avoiding wasted work.

Also documents the new options in suricata.yaml.in and the EVE JSON
output section of the user guide.
4 months ago
..
3rd-party-integration
…
_static
…
appendix doc: adjust for master to main rename 1 year ago
capture-hardware pcap-file: skip setvbuf on non-seekable streams 5 months ago
configuration doc/firewall: update hooks & configuration examples 5 months ago
devguide detect: convert tx_progress to uint8_t 4 months ago
file-extraction doc: minor verbiage tweaks and reST fix 1 year ago
firewall doc/firewall: update hooks & configuration examples 5 months ago
install doc/userguide: update windivert instructions 11 months ago
ips src: doc: remove double-space typos 10 months ago
licenses
…
lua http-log: remove support for http-log 5 months ago
manpages doc: improve manpage of suricatasc 5 months ago
output eve/mdns: add requests and responses config flags 4 months ago
partials pcap-file: skip setvbuf on non-seekable streams 5 months ago
performance http-log: remove support for http-log 5 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 2 years ago
protocols doc/userguide: add initial protocols overview 1 year ago
reputation
…
rule-management userguide: add references to rules/README to docs 8 months ago
rules doc: add missing "value" to entropy examples 4 months ago
upgrade doc: upgrade notes for changes to ike output 1 year ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 9 months ago
Makefile.sphinx
…
README.md
…
acknowledgements.rst doc: Add missing contributors to ack file 1 year ago
command-line-options.rst
…
conf.py doc: address config conversion note 6 months ago
convert.py
…
docutils.conf
…
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/userguide: add initial protocols overview 1 year ago
initscripts.rst
…
install.rst docs: use correct suricata version mentions 10 months ago
make-sense-alerts.rst
…
public-data-sets.rst doc: add more public datasets 8 months ago
quickstart.rst doc: clarify suricata.yaml location per install 4 months ago
requirements.txt
…
security.rst doc: fix typo /var/run/suricata in file permissions docs. 1 year ago
support-status.rst
…
unix-socket.rst doc: adjust for master to main rename 1 year ago
upgrade.rst flowbits: deprecate toggle command 5 months ago
verifying-source-files.rst docs: use correct suricata version mentions 10 months 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.