upstream/suricata
1
0
Fork 0
mirror of https://github.com/OISF/suricata.git synced 2026-02-03 20:41:46 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
suricata/doc/userguide
History
Fupeng Zhao f7ec1c8813 redis: Add authentication support 
Add authentication support to the Redis logging output.
It introduces `username` and `password` configuration options for Redis,
allowing Suricata to authenticate with Redis servers that require it.

Ticket: 7062
2026-02-02 15:49:25 +00:00
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 2019-03-05 11:41:08 +01:00
_static doc/userguide: avoid horizontal scroll on rtd 2023-07-15 17:12:51 +02:00
appendix doc: adjust for master to main rename 2025-09-16 17:20:56 +02:00
capture-hardware src: doc: remove double-space typos 2026-01-04 08:11:43 +00:00
configuration ssh: hassh can be truly disabled 2026-01-16 21:07:40 +00:00
devguide devguide/exceptions: minor fixes 2026-01-19 09:30:23 -03:00
file-extraction doc: minor verbiage tweaks and reST fix 2025-10-18 03:53:40 +02:00
firewall doc/userguide: add ips chapter; add concept 2025-09-14 10:43:18 +02:00
install doc/userguide: update windivert instructions 2025-12-11 04:30:42 +00:00
ips src: doc: remove double-space typos 2026-01-04 08:11:43 +00:00
licenses doc: convert fancy quotes to straight quotes 2019-06-17 20:09:08 +02:00
lua threads: remove thread group name logic 2025-12-02 06:21:54 +00:00
manpages userguide/suricatactl: use suricata community page 2025-03-09 21:52:42 +01:00
output redis: Add authentication support 2026-02-02 15:49:25 +00:00
partials redis: Add authentication support 2026-02-02 15:49:25 +00:00
performance hs: warn about the same cache directory 2026-01-16 06:09:37 +00:00
plugins doc/ndpi: move ndpi docs to new plugins section 2025-03-29 22:14:00 +01:00
protocols doc/userguide: add initial protocols overview 2025-09-23 21:32:15 +02:00
reputation doc: spelling 2023-05-08 11:59:32 +02:00
rule-management doc/reload: Expand rule-reload discussion 2025-07-10 19:36:39 +02:00
rules detect/detection_filter: add unique_on option 2026-01-27 20:54:44 +00:00
upgrade doc: upgrade notes for changes to ike output 2025-10-06 19:56:12 +02:00
.gitignore doc/userguide: generate eve documentation 2024-10-07 22:28:04 +02:00
acknowledgements.rst doc: Add missing contributors to ack file 2025-06-05 19:14:36 +02:00
command-line-options.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
conf.py docs: fix deprecated inclusion of rtd theme path 2025-08-27 08:42:36 +02:00
convert.py doc/optimization: move "convert.py" to Python3 2023-05-05 11:11:26 +02:00
docutils.conf doc: add docutils.conf to disable smart quotes 2023-05-05 18:59:33 +02:00
generate-evedoc.sh doc/userguide: generate eve documentation 2024-10-07 22:28:04 +02:00
index.rst doc/userguide: add initial protocols overview 2025-09-23 21:32:15 +02:00
initscripts.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
install.rst docs: use correct suricata version mentions 2026-01-14 12:49:11 +00:00
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
Makefile.am doc/userguide: add initial protocols overview 2025-09-23 21:32:15 +02:00
Makefile.sphinx doc: hook sphinx into build 2016-09-28 13:11:10 +02:00
public-data-sets.rst userguide: update Security Onion docs reference 2024-08-31 10:53:57 +02:00
quickstart.rst af-packet: remove use-mmap option 2025-03-22 07:11:59 +01:00
README.md devguide: move into userguide as last chapter 2022-03-29 07:56:03 +02:00
requirements.txt docs: adjust readthedocs config to new options 2023-10-06 21:28:15 +02:00
security.rst doc: fix typo /var/run/suricata in file permissions docs. 2025-09-20 09:08:40 +02:00
support-status.rst devguide: make 'contributing' a chapter 2024-01-04 15:51:21 +01:00
unix-socket.rst doc: adjust for master to main rename 2025-09-16 17:20:56 +02:00
upgrade.rst ssh: hassh can be truly disabled 2026-01-16 21:07:40 +00:00
verifying-source-files.rst docs: use correct suricata version mentions 2026-01-14 12:49:11 +00:00
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00

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.