Commit Graph

19 Commits (c73299a2984f3504149f7e2fde8d50865d2d3910)

Author SHA1 Message Date
Jason Ish 6ae5ae701b doc/userguide: generate eve documentation
Add EVE documentation for QUIC and Pgsql to their respective sections of
the userguide.

Also add a complete EVE reference as an appendix.

Other protocols can be done, but its a manual process to document in the
schema, then add the glue to pull them into the documentation.

The documentation is generated during "make dist", or if it doesn't
exist, "conf.py" will attempt to generate the eve documentation for
building on Readthedocs.
5 months ago
jason taylor 47d6c3a3ab doc: add source verification docs
Ticket: #6908

Signed-off-by: jason taylor <jtfas90@gmail.com>
9 months 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
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 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
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
Victor Julien 1c27a99827 doc: add upgrade page 5 years ago
Andreas Herz d657fd9bf0 doc: add quickstart guide 6 years ago
Victor Julien f1c83c3308 doc/userguide: new 3rd party section, add bluecoat
Add Symantec SSLV (bluecoat) doc to new 3rd party section for
documenting integrating Suricata with 3rd party tools.
6 years ago
Jason Ish 01f477786e doc: link in windows ips setup page 7 years ago
Eric Leblond 0c4bf2d332 doc: add a lua support top level section
Both output and signature are using lua. So lua functions should
be displayed in a single section.
7 years ago
Ralph Broenink 722cff1862 doc: Restructure ToC
* All sections up to 2 levels deep are now shown regardless of whether they are a separate page
* Rename Xbits and Thresholding for more consistent naming
* Minor adjustment in the Payload Keywords section
7 years ago
Victor Julien e24c3937b3 doc: add rule-management chapter 9 years ago
Victor Julien 6a831f8125 doc: add simple install guide 9 years ago
Jason Ish 214e97814c doc: bring in unix socket interaction from wiki 9 years ago
Victor Julien 7ad667f282 doc: move snort compat to rule chapter 9 years ago
Jason Ish 15d2a7a49d doc: minimal man page: suricata.1 9 years ago
Jason Ish 0e63c9ca41 doc: add GPL and CC licenses 9 years ago
Jason Ish 2751baae46 doc: rename from "sphinx" to "userguide" 9 years ago