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
Nick Price d0a85b7550 ja3: Mention LibNSS dependency for JA3 6 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static
capture-hardware doc: install eBPF files in share directory 6 years ago
configuration doc: convert fancy quotes to straight quotes 6 years ago
file-extraction file-log: remove and add warning 6 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua userguide: add documentation for Ja3SGetString Lua function 6 years ago
manpages doc: Add manpages for suricatasc and suricatactl 6 years ago
output userguide: formatting: remove tabs 6 years ago
partials doc: Add manpages for suricatasc and suricatactl 6 years ago
performance doc: convert fancy quotes to straight quotes 6 years ago
reputation userguide: remove old reference to rule-reload option 6 years ago
rule-management doc: convert fancy quotes to straight quotes 6 years ago
rules ja3: Mention LibNSS dependency for JA3 6 years ago
setting-up-ipsinline-for-linux
.gitignore
Makefile.am doc/userguide: add 3rd-party-integration to dist 6 years ago
Makefile.sphinx
README.md doc: Remove gulp references 6 years ago
acknowledgements.rst
command-line-options.rst
conf.py doc: Add manpages for suricatasc and suricatactl 6 years ago
convert.py
index.rst doc/userguide: new 3rd party section, add bluecoat 6 years ago
initscripts.rst
install.rst doc: fix minor typo 6 years ago
make-sense-alerts.rst
public-data-sets.rst
setting-up-ipsinline-for-linux.rst
setting-up-ipsinline-for-windows.rst Adds WinDivert support to Windows builds 7 years ago
unix-socket.rst doc: convert fancy quotes to straight quotes 6 years ago
what-is-suricata.rst

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Sphinx Document Generate 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.