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
Juliana Fajardini 45b7aad2b5 devguide: incorporate contribution process page
That page existed only in our redmine. Updated and added a few things,
like a paragraph about our expectations for feature contributors.

Also updated links, contacts and some other processes that may have
changed since last edition.

Added some section labels in related documents, for ease of referencing.

Task #4929
3 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static doc: Add suricata.css to allow for some custom styling 8 years ago
capture-hardware napatech: Added comment indicating that hba will be deprecated 5 years ago
configuration doc/tls: Add documentation for TLS logging 3 years ago
devguide devguide: incorporate contribution process page 3 years ago
file-extraction http2: allow filestore to work with HTTP2 5 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua userguide: rename pg Lua Scripting->Lua Detection 4 years ago
manpages userguide: update references to Suricata website 4 years ago
output doc/tls: Add documentation for TLS logging 3 years ago
partials ikev1: rename ikev2 to common ike 4 years ago
performance doc/userguide: sphinx syntax correction 3 years ago
reputation userguide: remove old reference to rule-reload option 6 years ago
rule-management doc: Improve grammar, spelling and clarifications 5 years ago
rules doc: Add missing ")" in example 3 years ago
setting-up-ipsinline-for-linux
upgrade doc: document removal of unified2 5 years ago
.gitignore doc: hook sphinx into build 9 years ago
Makefile.am devguide: drop use of mscgen script in builds/make 3 years 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 my own name to the acknowledgements 8 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py userguide: dynamically determine copyright date 3 years ago
convert.py
index.rst devguide: move into userguide as last chapter 3 years ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst pcre2: remove PCRE1 as dependency 4 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 4 years ago
quickstart.rst doc/quickstart: use new test url that works 4 years ago
setting-up-ipsinline-for-linux.rst doc: Improve grammar, spelling and clarifications 5 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
unix-socket.rst doc: fix URL for unix-socket python example 5 years ago
upgrade.rst doc/userguide: updates for eve dns v1 removal 3 years 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.