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
Victor Julien 37a871d96f nfs: bound partial metadata replies with max-metadata-size
A partial v3 reply that carries no file data is skipped rather than
buffered toward its claim, which for LOOKUP, READDIRPLUS and CREATE drops
the handle to name mapping their replies establish. The exception to that
reused max-read-size, so those procedures depended on a knob that
documents READ data, and lowering it for READs silently dropped the
mapping of any directory reply above it; the mapping depends on
segmentation, as the same reply parses when it arrives in one piece.

Give them a limit of their own, max-metadata-size, with a 16 MiB default,
and use it to decide whether such a reply may still buffer toward its
record claim. A value of 0 falls back to the default, so the buffering
stays bounded and the limit cannot be disabled. The WRITE and READ limits
share that default through NFS_MAX_RW_SIZE_DEFAULT. Documented in the
userguide.

Ticket: #9263.
22 hours 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 nfs: bound partial metadata replies with max-metadata-size 22 hours ago
devguide doc: update the SSH docs for the reworked state machine 3 weeks ago
file-extraction doc: minor verbiage tweaks and reST fix 1 year ago
firewall firewall: reject flow scope for the pre-flow hook 3 weeks ago
install doc/userguide: update windivert instructions 11 months ago
ips src: doc: remove double-space typos 10 months ago
licenses
…
lua doc: update the SSH docs for the reworked state machine 3 weeks ago
manpages windows: reopen log files with service control code 2 days ago
output windows: reopen log files with service control code 2 days ago
partials doc: list-keywords with json output 3 weeks 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 windows: reload rules with service control code 2 days ago
rules docs: note about no config action support in fw mode 1 week 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 doc: update Rust installation instructions 2 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 doc: update the SSH docs for the reworked state machine 3 weeks 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.