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
Shivani Bhardwaj 58367149cc doc: add upgrade note about change in inspection 3 days ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
appendix doc/userguide: add appendix item on eve schema 2 weeks ago
capture-hardware threading: support previous threading configuration format 4 weeks ago
configuration threading: support thread autopinning and interface-specific affinity 4 weeks ago
devguide doc/devguide: document app-layer protocol detection 7 days ago
file-extraction doc/file-extraction: fix highlight syntax 10 months ago
firewall doc/ssh: document hooks 2 months ago
install doc/install: use our recommended header order 2 weeks ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc/lua: document request_host lua lib 4 weeks ago
manpages userguide/suricatactl: use suricata community page 4 months ago
output doc: document krb5 event type 7 days ago
partials pcap-file: document capture method options 1 month ago
performance threading: support previous threading configuration format 4 weeks ago
plugins doc/ndpi: move ndpi docs to new plugins section 3 months ago
reputation doc: spelling 2 years ago
rule-management userguide: expand documentation for rule profiling 10 months ago
rules doc/devguide: document app-layer protocol detection 7 days ago
setting-up-ipsinline-for-linux doc: rename from "sphinx" to "userguide" 9 years ago
upgrade doc/upgrade: note about dns address swap on responses 3 weeks ago
.gitignore doc/userguide: generate eve documentation 9 months ago
Makefile.am doc/install: windows build documentation 2 weeks ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc: Add missing contributors to ack file 4 weeks ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/userguide: generate eve documentation 9 months ago
convert.py doc/optimization: move "convert.py" to Python3 2 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 2 years ago
generate-evedoc.sh doc/userguide: generate eve documentation 9 months ago
index.rst doc/firewall: start of documentation 3 months ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst doc/userguide: break out package installation 2 weeks ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update Security Onion docs reference 10 months ago
quickstart.rst af-packet: remove use-mmap option 3 months ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst userguide/security: grammar fixes 2 years ago
setting-up-ipsinline-for-linux.rst threading: support previous threading configuration format 4 weeks ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst doc: remove python references related to suricatasc 4 months ago
upgrade.rst doc: add upgrade note about change in inspection 3 days ago
verifying-source-files.rst doc: add source verification docs 1 year ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 5 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.