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 fd742034a6 ntp: add transaction logging
Adds basic NTP transaction logging for the current supported message
types.

Includes small cleanups around reference ID.

Ticket: #8425
(cherry picked from commit 31b967b089)
4 months ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 3 years ago
appendix doc: adjust for master to main rename 1 year ago
capture-hardware doc/af-packet: document disable-hwtimestamp option 9 months ago
configuration doc/stream: explain absent reassembly.depth means unlimited 6 months ago
devguide devguide: add chapter about exception policies 7 months ago
file-extraction doc/file-extraction: fix highlight syntax 2 years ago
firewall doc/userguide: add ips chapter; add concept 1 year ago
install doc: adjust for master to main rename 1 year ago
ips doc/userguide: add ips chapter; add concept 1 year ago
licenses
lua doc/lualib: fix wrong tuple section markdown in flowlib 1 year ago
manpages userguide/suricatactl: use suricata community page 2 years ago
output eve: add rule generation source to alert record 4 months ago
partials ntp: add transaction logging 4 months ago
performance hs: prune stale MPM cache files 6 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 1 year ago
reputation doc: spelling 3 years ago
rule-management doc/reload: Expand rule-reload discussion 1 year ago
rules detect/snmp: add snmp.trap_type keyword 5 months ago
upgrade doc/upgrade: note about dns address swap on responses 1 year ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 7 months ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 5 years ago
acknowledgements.rst doc: Add missing contributors to ack file 1 year ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 6 years ago
conf.py docs: fix deprecated inclusion of rtd theme path 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 2 years ago
index.rst doc/userguide: add a known issues page 11 months ago
initscripts.rst doc: Improve grammar, spelling and clarifications 6 years ago
install.rst docs: use correct suricata version mentions 8 months ago
known-issues.rst doc/userguide: add a known issues page 11 months ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 6 years ago
public-data-sets.rst doc: add more public datasets 6 months 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 doc: fix typo /var/run/suricata in file permissions docs. 11 months ago
support-status.rst devguide: make 'contributing' a chapter 3 years ago
unix-socket.rst doc: adjust for master to main rename 1 year ago
upgrade.rst doc/config: Update flushing description 4 months ago
verifying-source-files.rst docs: use correct suricata version mentions 8 months ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 6 years ago

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.