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
Jason Ish f303d50441 windows: reload rules with service control code
Windows has no SIGUSR2 and no unix socket, so rules could not be reloaded
without restarting Suricata. When running as a service, a rule reload can now
be requested with the user-defined control code 128, for example:

    sc.exe control Suricata 128

The service control handler only records the request; the main loop then
handles it the same as SIGUSR2.

Ticket: 7756
2 days ago
..
3rd-party-integration
…
_static
…
appendix
…
capture-hardware pcap-file: skip setvbuf on non-seekable streams 5 months ago
configuration nfs: enforce max read/write queue size and count limits 2 months ago
devguide doc: update the SSH docs for the reworked state machine 3 weeks ago
file-extraction
…
firewall firewall: reject flow scope for the pre-flow hook 3 weeks ago
install
…
ips
…
licenses
…
lua doc: update the SSH docs for the reworked state machine 3 weeks ago
manpages windows: reload rules with service control code 2 days ago
output util/log: rotate calendar intervals on local-time boundaries 5 days ago
partials doc: list-keywords with json output 3 weeks ago
performance
…
plugins
…
protocols
…
reputation
…
rule-management windows: reload rules with service control code 2 days ago
rules docs: note about no config action support in fw mode 1 week ago
upgrade
…
.gitignore
…
Makefile.am
…
Makefile.sphinx
…
README.md
…
acknowledgements.rst
…
command-line-options.rst
…
conf.py
…
convert.py
…
docutils.conf
…
generate-evedoc.sh
…
index.rst
…
initscripts.rst
…
install.rst doc: update Rust installation instructions 2 months ago
make-sense-alerts.rst
…
public-data-sets.rst
…
quickstart.rst doc: clarify suricata.yaml location per install 4 months ago
requirements.txt
…
security.rst
…
support-status.rst
…
unix-socket.rst
…
upgrade.rst doc: update the SSH docs for the reworked state machine 3 weeks ago
verifying-source-files.rst
…
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.