Jason Ish
7d6bc60abb
doc/userguide: document ftp max-line-length
3 years ago
Victor Julien
976748b777
doc/smb: add resource limits section
3 years ago
William Harding
f0528afc2d
doc/userguide: sphinx syntax correction
3 years ago
Juliana Fajardini
55843aee8e
devguide: update readme
...
Use it to explain how to go about the sequence diagram images
(generation, updating, what is mscgen etc).
Also remove portion that referred to Sphinx builds, as these don't make
sense now.
3 years ago
Juliana Fajardini
e0c8dba7ac
userguide: dynamically determine copyright date
...
This uses the date of doc generation to determine the copyright date
for the trailing date. Based on Jeff Lucovsky solution.
3 years ago
Juliana Fajardini
67af1504b3
devguide: drop use of mscgen script in builds/make
...
Currently, it seems easier to upload the diagram images to git than to
try to make the image generation script work with out of the tree builds
and other corner cases.
This means, however, that one must activelly remember to update msc
diagram files, run the script and re-add new png files, if those ever
need to be updated. To raise awareness to that, a watermark was added
to the diagram images.
Also removed configuration steps that added mscgen as dependency
(locally and for workflow builds and readthedocs).
3 years ago
Juliana Fajardini
5d63613c4b
devguide: add watermark to sequence diagrams
...
Make it more evident that the sequence diagrams in the transactions
page are generated with Mscgen
3 years ago
Juliana Fajardini
6f77c722a2
devguide: move into userguide as last chapter
...
Moved devguide dir into userguide dir.
Since the devguide is now incorporated as the last chapter of the
userguide, removed build and configuration files from the devguide
dir, as these are no longer needed.
Task #4909
3 years ago
Philippe Antoine
cfcade58ad
http: move xff logging to alert object
...
Ticket: 4860
instead of root field
3 years ago
Andreas Dolp
d4144c04cd
Doc: Fix typo in documentation of suricata.yaml.
3 years ago
Shivani Bhardwaj
015c9fe1e3
doc: add usage of flowbits OR op
...
Ticket 5130
3 years ago
Jeff Lucovsky
117e11b0ae
doc: Describe per-thread stack size config setting
...
Issue: 4550
This commit documents the new per-thread stack-size setting. Some
systems have a small default value that is not suitable for Suricata's
multi-threaded architecture and adjustment may be required.
3 years ago
Victor Julien
e04fcfcf2f
doc/userguide: minor rewording and reformatting for runmodes
3 years ago
Philippe Antoine
8adf172ab8
nfs: limits the number of active transactions per flow
...
Ticket: 4530
3 years ago
Philippe Antoine
11d3af551b
doc: suricata.yaml fields about maximum transactions
...
For HTTP2, MQTT and FTP.
3 years ago
Juliana Fajardini
579d7dcc01
pgsql: add initial support
...
- add nom parsers for decoding most messages from StartupPhase and
SimpleQuery subprotocols
- add unittests
- tests/fuzz: add pgsql to confyaml
Feature: #4241
3 years ago
Victor Julien
cf4ddab6f4
doc/quic: update for new quic.version logic
3 years ago
Emmanuel Thompson
6641efb74f
doc/quic: Add documentation for QUIC keywords
3 years ago
Emmanuel Thompson
9ad60e7661
doc/quic: Add quic to eve json format
3 years ago
Andreas Dolp
f714484591
Doc: Fix typos in documentation of suricata.yaml.
3 years ago
Philippe Antoine
0cfdec1266
detect: xor transform
...
Ticket: 3285
The xor transform applies xor decoding to a buffer, with a key
specified as an option in hexadecimal. Arbitrary key sizes are
accepted.
3 years ago
Jason Ish
cda11b8d97
doc/update: mention change of default rule path
3 years ago
Jason Ish
8071d8239e
doc: update rule section to current default
...
Update the rule section to better describe whats seen in a default
install of Suricata including a link to the rule management section.
3 years ago
Jeff Lucovsky
93842aa14a
doc/yaml: Signal-termination option description
3 years ago
Juliana Fajardini
de0ce26e3f
userguide: update references to Suricata website
...
Many places were still referencing the old Suricata page.
Used git grep with replace to update them. Checked that new links work.
Left old references when they were only documentation examples (for
output or unittests).
Task#4915
3 years ago
Juliana Fajardini
7b20488d4e
userguide: fix low-hanging typos Config page
3 years ago
Odin Jenseg
2a5d79e426
doc/eve-json-format/dns: Describing Z-bit
3 years ago
Lukas Sismis
dab3274263
dpdk: add documentation for the DPDK runmode
...
Briefly present the DPDK runmode through configuration file.
3 years ago
Lukas Sismis
e4b5239202
doc: fix typo in "Stream engine" documentation
3 years ago
Philippe Antoine
27dd0c6b3d
eve/ftp-data: log alert metadata in ftp-data object
...
Ticket: 4860
instead of directly in root
3 years ago
Juliana Fajardini
7c636d25c7
userguide: (nit) fix typo in lua-output page
3 years ago
Juliana Fajardini
4256c1ccd5
userguide: rename pg Lua Scripting->Lua Detection
...
Since we can have scripts for output _or_ detection, it seems more
clear to rename this page to add more meaning
3 years ago
Juliana Fajardini
59e5a21fca
userguide: update buffers list for lua-scripting
3 years ago
Juliana Fajardini
e7f1736f3a
userguide/lua: add explanation about `need` diffs
...
The differences on how the `need` key works, depending on script
usage (output or detection) confuses users, sometimes (cf doc#4725).
While we don't fix that, just explain this behavior.
3 years ago
Andreas Dolp
b25350ee13
doc: Fix typo in documentation of rule keyword flow
3 years ago
Juliana Fajardini
fc958e9e89
userguide: update wiresharkwiki in public datasets
3 years ago
Philippe Antoine
bce3c46874
pcre2: remove PCRE1 as dependency
3 years ago
Philippe Antoine
fae7389ae2
pcre2: document the behavioral changes
3 years ago
Juliana Fajardini
751906b71d
doc/lua-functions: add sha items to SCFileInfo doc
4 years ago
Jason Ish
2cff811609
doc: remove prelude and document as removed
4 years ago
Jason Ish
3e9d1e813a
doc/upgrade: move ike logging changes to 7.0 changes
...
Was mistakenly put in 6.0 changes.
4 years ago
Jason Ish
f56634ac46
doc/upgrade: mention that nss is no longer required
4 years ago
Lukas Sismis
71196098a1
doc: Update public-data-sets.rst
...
Replace dead link
Dataset on ll.mit.edu returns 404. Link updated with a search result of more datasets.
4 years ago
Joshua Lumb
cf9b2b5fd1
detect-dsize: Add ! operator for dsize matching
4 years ago
myr463
755124763d
doc: escape dot in pcre
4 years ago
Shivani Bhardwaj
51be8f0238
doc/dcerpc: add proto keywords
4 years ago
showipintbri
a39025bf24
doc: Grammar Correction
4 years ago
Juliana Fajardini
6b8b58f98a
doc/eve: common fields and alert updates
...
- update examples for both
- change app_proto from alert field to common field, as
per JsonBuilder's changes.
4 years ago
Juliana Fajardini
eacf933edf
doc/eve: fix typos
4 years ago
Philippe Antoine
95f225e8fb
doc: update sphinx api to use add_css_file
...
instead of deprecated add_stylesheet
4 years ago