mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
d7bf52e71c
Rust website has changed the location of the installer. Additionally their installer now includes automatic append to .bashrc to source the correct path to Rust binaries. Cbindgen as an instruction is also removed as it is not needed when building from the downloaded and packaged Suricata. Ticket: 8344 |
2 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | 3 years ago | |
| appendix | 1 year ago | |
| capture-hardware | 5 months ago | |
| configuration | 4 months ago | |
| devguide | 2 months ago | |
| file-extraction | 1 year ago | |
| firewall | 2 months ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 5 months ago | |
| manpages | 5 months ago | |
| output | 3 months ago | |
| partials | 5 months ago | |
| performance | 5 months ago | |
| plugins | 2 years ago | |
| protocols | 1 year ago | |
| reputation | 4 years ago | |
| rule-management | 8 months ago | |
| rules | 2 months ago | |
| upgrade | 1 year ago | |
| .gitignore | 2 years ago | |
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | 1 year ago | |
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | 4 years ago | |
| generate-evedoc.sh | 2 years ago | |
| index.rst | 1 year ago | |
| initscripts.rst | ||
| install.rst | 2 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 8 months ago | |
| quickstart.rst | 4 months ago | |
| requirements.txt | 3 years ago | |
| security.rst | 1 year ago | |
| support-status.rst | 3 years ago | |
| unix-socket.rst | 1 year ago | |
| upgrade.rst | 5 months ago | |
| verifying-source-files.rst | 10 months ago | |
| what-is-suricata.rst | ||
README.md
Suricata User Guide
This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.
Verifying Changes
There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.
There are different application dependencies based on the output desired.