Shivani Bhardwaj
2c4d6b33ae
doc/conf: fix sphinx language setting
...
sphinx-build 5.1.1 and above throws a warning which is treated as an
error while building.
Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
3 years ago
Benjamin Wilkins
3b1b9a32fb
doc: Document SCByteVarGet lua function
...
Add documentation for accessing results from byte_extract and byte_math
in lua match functions
Issue: 2871
3 years ago
Philippe Antoine
5c7b5c5fb5
krb: detection for ticket encryption
...
As is done for logging.
Ticket: #5442
3 years ago
Jufajardini Reichow
61f9f0df55
userguide/rules/meta: minor formatting adjustments
3 years ago
Jufajardini Reichow
45f14bb97c
userguide/rules: explain sid uniqueness within gid
...
While Suri will throw an error if two signatures have the same `sid`
and no `gid`, or same `sid` and same `gid`, it will just accept same
`sid` for different `gid`s.
Related to
Task #5441
3 years ago
jason taylor
87990b138c
doc: update priority wording userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
a7d739a05b
doc: update to 80 char formatting userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
9bd55ff81b
doc: metadata information update userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
563dc66837
doc: update priority information userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
f73a60eb89
doc: update reference section in userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
e611ef5ccb
doc: update userguide meta classtype information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
39bc56ec97
doc: update rev and gid userguide meta wording
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
b9cb66c58f
doc: add clarity around userguide meta information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
790ef9a53f
doc: add sid reserved range reference
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
38a179d89d
doc: add clarity to rule msg tips
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
299a931e49
doc: update example rule list
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
98c29da6ec
doc: add clarity to role wording
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
c0bdb6cc10
doc: meta keyword doc example rule update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
ca9e9009ba
doc: add bsize keyword examples
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Jufajardini Reichow
f9c9091bb5
userguide: fix typo in inline mode illustration
...
The image describing Suricata's sliding window had two of the "packets"
with the same text. Now they actually give the sense of a sliding
window.
This was found by Zhiyuan-liao.
3 years ago
jason taylor
34e0a384ad
doc: update to include additional rule references
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
4405704372
doc: update intro direction content
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
3eeacf8a3d
doc: fixed HOME_NET/EXTERNAL example formatting
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
f2c7998903
doc: add clarity around HOME_NET/EXTERNAL_NET
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
76cca8b08a
doc: minor example rule description update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
4f61a35fe7
doc: minor wording restructure
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
845ba154a6
doc: add tcp-pkt/tcp-stream to intro
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
56f49bfe8e
doc: minor punctuation update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
ab300ab0ae
doc: intro example rule update to simpler example
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
2f240230f0
doc: minor intro wording update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Philippe Antoine
c7214be99b
snmp: adds usm keyword
...
as is logged
Ticker: #5416
3 years ago
Juliana Fajardini
45b7aad2b5
devguide: incorporate contribution process page
...
That page existed only in our redmine. Updated and added a few things,
like a paragraph about our expectations for feature contributors.
Also updated links, contacts and some other processes that may have
changed since last edition.
Added some section labels in related documents, for ease of referencing.
Task #4929
3 years ago
Andreas Dolp
db73a12540
doc/tls: Add documentation for TLS logging
3 years ago
Andreas Dolp
f42bb45ccd
doc/tls: Remove redundant example
3 years ago
Andreas Dolp
324f5ec10c
doc: Add missing ")" in example
3 years ago
Andreas Dolp
e4163c4e02
doc: Fix typos
3 years ago
Andreas Dolp
49bd6cfa5d
doc: Fix broken link
3 years ago
Eric Leblond
6f06f7c22c
doc: add info about capture_file key
3 years ago
Eric Leblond
0c7e4c13a1
doc: add conditional pcap logging info
3 years ago
jason taylor
d799956348
doc: add note about file.data and file_data
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
83f2056d20
doc: update file_data to file.data keyword
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
cd54d0dbc8
doc: remove extra newline in order to match style
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
38bd775ca0
doc: remove extraneous + characters
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Jason Ish
6ceeb08351
doc/userguide: updates for eve dns v1 removal
...
Ticket: #4157
3 years ago
Juliana Fajardini
1956dc3d5d
userguide: explain alert queue behavior and stats
...
Added sections along packet-alert-max config section explaining
packet alert queue overflow (when Suri reaches packet alert max), when
alerts are discarded etc.
Since from the user perspective it shouldn't matter how we process the
alert queue, the term "replace" is used, even though there's not exactly
a replacing action happening, with the queue bein pre-processed before
being appended to the Packet.
Also described the associated stats and added an explanation on when to
change packet-alert-max.
Task #5178
3 years ago
Juliana Fajardini
49542d0f1b
doc/userguide: explain packet-alert-max config
...
Task #4207
3 years ago
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