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.

History

Juliana Fajardini bb59124063 yaml: unify 0 stats counter config option terms When we added feature #5976 (`72146b969`), we overlook that we also have a config stats option for the human-readable stats logs to output 0 counters. Due to not seeing this before, we now have two different setting names for basically the same thing, but in different logs: - zero-valued-counters for EVE - null-values for stats.log This ensures we use the same terminology, and change the recently added one to `null-values`, as this one has been around for longer. Task #6962		11 months ago
..
3rd-party-integration	…
_static	…
capture-hardware	dpdk: add interrupt (power-saving) mode	1 year ago
configuration	userguide: document exception policy stats	11 months ago
devguide	devguide: add an upgrade section	12 months ago
file-extraction	…
licenses	…
lua	…
manpages	…
output	yaml: unify 0 stats counter config option terms	11 months ago
partials	yaml: unify 0 stats counter config option terms	11 months ago
performance	…
reputation	…
rule-management	…
rules	app-layer: websockets protocol support	11 months ago
setting-up-ipsinline-for-linux	…
upgrade	…
.gitignore	…
Makefile.am	docs/userguide: use a consistent date for reproducible builds	11 months ago
Makefile.sphinx	…
README.md	…
acknowledgements.rst	…
command-line-options.rst	…
conf.py	docs/userguide: use a consistent date for reproducible builds	11 months ago
convert.py	…
docutils.conf	…
index.rst	…
initscripts.rst	…
install.rst	config/nss: Remove libnspr/libnss traces	1 year ago
make-sense-alerts.rst	…
public-data-sets.rst	…
quickstart.rst	…
requirements.txt	…
security.rst	…
setting-up-ipsinline-for-linux.rst	…
setting-up-ipsinline-for-windows.rst	…
support-status.rst	…
unix-socket.rst	…
upgrade.rst	eve/stats: allow hiding counters whose valued is 0	11 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.