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 8781e9352a doc/userguide: add documentation for SMTP frames 1 year ago
..
3rd-party-integration
_static
capture-hardware
configuration doc: Initial doc for lua sandbox 1 year ago
devguide devguide: highlight commit message example 1 year ago
file-extraction
licenses
lua
manpages
output doc: add arp changes 1 year ago
partials doc: add arp changes 1 year ago
performance
reputation
rule-management
rules doc/userguide: add documentation for SMTP frames 1 year ago
setting-up-ipsinline-for-linux
upgrade
.gitignore
Makefile.am doc: add source verification docs 1 year ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py docs/userguide: use a consistent date for reproducible builds 1 year ago
convert.py
docutils.conf
index.rst doc: add source verification docs 1 year ago
initscripts.rst
install.rst lua: use rust crate to vendor (bundle) lua 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 http: configures libhtp to allow spaces in uri 1 year ago
verifying-source-files.rst doc: add source verification docs 1 year 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.