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 bba3d4fc63 userguide/eve: explain pgsql requests & responses
Add a more visible explanation of that requests, responses, frontend and
and backend are, in Pgsql context, to avoid having to repeat that over
different portions of the docs.
2 years ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
capture-hardware napatech: update docs to remove hba reference 2 years ago
configuration doc/userguide: document host table yaml settings 2 years ago
devguide detect: rename DetectAppLayerInspectEngineRegister2 2 years ago
file-extraction doc/userguide: spelling 2 years ago
licenses
lua doc/userguide: improve SCStreamingBuffer example 2 years ago
manpages doc/userguide: spelling 2 years ago
output userguide/eve: explain pgsql requests & responses 2 years ago
partials doc/userguide: add reload-tenant(s) doc 2 years ago
performance doc/userguide: update ref to installation from git 2 years ago
reputation doc: spelling 2 years ago
rule-management doc/rule-profiling: fix suricatasc typo 2 years ago
rules doc/userguide: document dns.query.name, dns.answer.name 2 years ago
setting-up-ipsinline-for-linux
upgrade
.gitignore
Makefile.am configure: more idiomatic autoconf for sphinx-build checks 2 years ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst
conf.py userguide: remove old css files 2 years 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
index.rst doc/userguide: display version on front page 2 years ago
initscripts.rst
install.rst userguide: add proper label to RPM install section 2 years ago
make-sense-alerts.rst
public-data-sets.rst userguide: update wiresharkwiki in public datasets 4 years ago
quickstart.rst doc/quickstart: add software-properties instruction 2 years 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 doc: fix description of iptables rules 2 years ago
setting-up-ipsinline-for-windows.rst
support-status.rst doc/support-status: add support status page 2 years ago
unix-socket.rst suricatasc: update running instructions 2 years ago
upgrade.rst doc/userguide: update guidance on 5 to 6 upgrading 2 years 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.