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/devguide
History
Juliana Fajardini 2c216e2b73 devguide/exceptions: minor fixes 
- cleaner YouTube link
- fix weird sentence

Follow-up of
Task #5612
2026-01-19 09:30:23 -03:00
..
codebase devguide: add chapter about exception policies 2026-01-16 21:07:32 +00:00
contributing src: doc: remove double-space typos 2026-01-04 08:11:43 +00:00
extending devguide/exceptions: minor fixes 2026-01-19 09:30:23 -03:00
internals doc: add doc on internals of inspection of raw data 2025-09-13 08:40:09 +02:00
libsuricata doc: adjust for master to main rename 2025-09-16 17:20:56 +02:00
upgrading doc/devguide: explain alert logging changes 2025-11-04 17:33:07 +01:00
index.rst devguide: add an upgrade section 2024-03-16 09:29:34 +01:00
README.md devguide: update readme 2022-03-29 07:56:03 +02:00

README.md

Suricata Developer Guide

This directory contains the Suricata Developer's Guide. It is built as part of the Suricata Userguide.

The Sequence Diagrams seen in the Transactions documentation are generated with Mscgen. Mscgen is a small program to parse Message Sequence Charts that can be represented as text and can then converted to image.

If you need to update the diagrams, please edit the .msc files present in the diagrams directory (extending/app-layer/diagrams). Once those have been changed, in the scripts directory (in the main Suricata dir) there's a scrip that will generate images for all files: generate-images.sh (you'll have to install Mscgen for that to work).

More info about Mscgen can be found at: https://www.mcternan.me.uk/mscgen/