Comfort Amaechi
cf8b630ed2
userguide: cover install-full and install-conf
...
Ticket: #6342
1 year ago
jason taylor
535938d7f6
doc: add tls.cert_chain_len docs
...
Ticket: #6386
Signed-off-by: jason taylor <jtfas90@gmail.com>
1 year ago
Juliana Fajardini
1a132f454a
docs: adjust readthedocs config to new options
...
Our documentation was failing to build, seems connected to the new way
of indicating build options (cf
https://readthedocs.org/projects/suricata/builds/22112658/ ,
https://docs.readthedocs.io/en/stable/config-file/v2.html#build ,
and https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os ).
Added the build.os required new field, and adjusted the way python
version is passed.
For the new configuration style for read the docs, one of the ways to
pass extra configuration for python is having a requirements file.
1 year ago
Juliana Fajardini
ffed5eb3d3
doc/quickstart: add software-properties instruction
...
This is indicated in the `Installation` section, but not in the
quickstart, and it felt like a valid addition, here, too.
1 year ago
Juliana Fajardini
4ab4f711de
doc/install: link to devguide's install from git
...
Although we have an updated version of instructions for installation
from git, our install guide was only referring to RedMine, which is less
up-to-date.
Kept that reference, since it might still be useful for non-Ubuntu
cases.
1 year ago
Shivani Bhardwaj
0a4011655f
doc/code-submission: add commit sign guide
1 year ago
Travis Green
96a0e7016f
doc: add tcp flags documentation
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
1 year ago
Jason Ish
2b57179d65
readthedocs: pin theme to sphinx_rtd_theme
...
ReadTheDocs changed the default theme.
2 years ago
Jason Ish
ae3b1a9e36
configure: more idiomatic autoconf for sphinx-build checks
...
- Use SPHINX_BUILD instead of HAVE_SPHINX_BUILD, as here we're
actually using the path of the program.
- Wrap some elements in [] as is done in modern idiomatic autoconf
2 years ago
Victor Julien
c0201d3212
doc/userguide: add reload-tenant(s) doc
2 years ago
Victor Julien
6ba0956a75
multi-tenant: allow reload w/o yaml path
...
Store yaml path in de ctx, for reloads w/o path.
This allows for a simpler `reload-tenant N`, where the previously
used yaml is reloaded.
2 years ago
Victor Julien
c87803ea0e
detect: add multi-detect.config-path
...
Add option to specify path from which to load the tenants.
Mostly meant to be used in testing.
2 years ago
jason taylor
be324d7856
doc: update file.magic information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor
008cc78a03
doc: update fileext keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor
e99b1787a2
doc: update file.name keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Alexandre Iooss
c80941dd8d
doc/userguide: improve SCStreamingBuffer example
...
Add direction indication in SCStreamingBuffer usage example.
This adds documentation for the changes introduced by commit
5b1d8c7e94
.
2 years ago
Juliana Fajardini
5cef8fdfdf
userguide/ppa: fix typo
...
The launchpad repo for suricata-beta read 'oisd' instead of 'oisf'
2 years ago
Juliana Fajardini
4fd3205bf0
userguide/install: add info on ubuntu ppa installs
...
Bringing info that was only in our Redmine wiki to our documentation.
Task #6231
2 years ago
Juliana Fajardini
765b05f139
docs: miscellanea updates
...
- Fix a DPDK reference link, add some line breaks.
- Exemplify what a good commit message looks
like, for Suricata's commit style.
2 years ago
Jason Ish
3e2a62915b
doc/userguide: display version on front page
...
When viewing the docs online at Readthedocs, or similar it might be
immediately apparent what version of the documentation is being
displayed. Display the version on the first line before the table of
contents to make it clear.
2 years ago
Andreas Herz
26130d903f
doc: add note about cpu prio overwrite behavior
2 years ago
Andreas Herz
da68692547
doc: dataset - add type to be mandatory
2 years ago
Juliana Fajardini
f16d428fd1
userguide/upgrade: link to exception policy FAQ
...
With the release of 7, people are starting to have issues with traffic
being blocked. While we don't add a more expansive documentation for
this, add a link to the FAQ covering possible fixes for drops caused by
the fail closed default behavior of the exception policies.
2 years ago
Juliana Fajardini
24745b3a73
doc/userguide: update ref to installation from git
...
It was still pointing to the redmine wiki and the documentation to be
truthful to the new documentation.
2 years ago
Jason Ish
500a7abf57
doc/support-status: add support status page
...
Convert the wiki page,
https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Support_Status
into a page that is versioned along with the user guide.
Includes many updates to reflect our current support status.
2 years ago
Jason Ish
ad94ebddb7
doc/userguide: avoid horizontal scroll on rtd
...
Add CSS to avoid horizontal scroll in tables on ReadTheDocs. This will
wrap the text instead.
Also, vertically align to top so if a cell does wrap, other cells that
do not wrap don't place the text in the middle of the cell.
2 years ago
Juliana Fajardini
9900bdc162
userguide/eve: format and reorganize alert section
...
The `field action` portion seemed to be comprised of a more generic
section that followed it. Also formatted the section for lines to be
within the character limit.
2 years ago
Juliana Fajardini
0437173848
output/drop: add verdict field
...
Related to
Bug #5464
2 years ago
Andreas Herz
24bcaf07ae
doc/upgrade: add more 6 to 7 changes and minor improvements
...
Issue: #5473
2 years ago
jason taylor
62170d2fb9
doc: hyperscan information updated
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor
c95fce39f0
doc: add multi buffer support note to keyword docs
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor
88960e909d
doc: add multiple buffer matching documentation
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Jason Ish
0b5dc58e15
doc/userguide: more eve http upgrade notes
...
Add more information with a examples of how the changes to EVE HTTP
logging may affect users.
2 years ago
jason taylor
19a0b2b0d2
userguide: add details about tcp flow pass
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Jeff Lucovsky
47e268d609
detect/byte_math: Document bytes variable name
...
Issue: 6145
Document that byte_math accepts a variable name for bytes (optional)
2 years ago
Jeff Lucovsky
3a4554fc2b
detect/byte-jump: Document var usage for nbytes
...
Issue: 6105
2 years ago
Jeff Lucovsky
73b943276e
doc/byte_test: Document byte_test variable usage
...
Issue: 6144
This commit updates the byte_test documentation now that a variable name
can be used for the nbytes value.
2 years ago
Lukas Sismis
5a3ecbde62
doc: update install instructions
...
Ticket: #5987
2 years ago
Shivani Bhardwaj
b6f8f5eb3b
doc/http: use "sticky buffer" where applicable
2 years ago
Jeff Lucovsky
ac8f91f44f
config: Document cluster_rollover deprecation
...
Issue: 6128
cluster_rollover is no longer permitted; using it will generate a
warning message and it'll be replaced with cluster_flow
2 years ago
Jeff Lucovsky
29621c7f0d
doc/afpacket: Document rollover deprecation
2 years ago
Juliana Fajardini
e306bc6ecc
exception: fix use of master switch with default
...
If an exception policy wasn't set up individually, use the GetDefault
function to pick one. This will check for the master switch option and
handle 'auto' cases.
Instead of deciding what the auto value should be when we are parsing
the master switch, leave that for when some of the other policies is to
be set via the master switch, when since this can change for specific
exception policies - like for midstream, for instance.
Update exceptions policies documentation to clarify that the default
configuration in IPS when midstream is enabled is `ignore`, not
`drop-flow`.
Bug #6169
2 years ago
Shivani Bhardwaj
18947c01e0
suricatasc: update running instructions
2 years ago
Jeff Lucovsky
d822ba58e1
doc/multi-tenant: Clarify live traffic support
...
Issue: 5930
This commit clarifies the live traffic support for multi-tenancy.
2 years ago
Shivani Bhardwaj
aeb408dd9d
doc: fix typo encryption-handling
2 years ago
Jason Ish
90bb73046c
userguide/security: grammar fixes
...
Apply grammer fixes brought up in GitHub review comments by Juliana.
2 years ago
liaozhiyuan
a748164d58
dpdk: support multiple same EAL arguments
...
DPDK apps can specify multiple arguments of the same
type. YAML format only allows unique keys within a single
node. This commit adds support for multiple EAL arguments
of the same type to be used within suricata.yaml.
Ticket: #5964
2 years ago
Jason Ish
5f598931ac
doc/userguide: start on a security chapter
...
This is the start of a security consideration chapter, starting with
directions on how to run Suricata as a non-root user.
2 years ago
Jason Ish
14daa42e0b
doc/userguide: dataset upgrade notes
2 years ago
Jason Ish
4a97461f9a
doc/userguide: notes about Lua rules being disabled by default
2 years ago