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.
suricata/doc/sphinx
Andreas Herz 715485a42b doc: finished remaining conversion for output 9 years ago
..
_static docs: sample of sphinx docs 9 years ago
capture-hardware doc: added capture hardware except for napatech with file 9 years ago
configuration doc: minor fixes in configuration causing errors/warnings 9 years ago
file-extraction doc: finished remaining conversion for output 9 years ago
oinkmaster doc: oinkmaster 9 years ago
output doc: finished remaining conversion for output 9 years ago
performance doc: reference fixups 9 years ago
reputation doc: add index for reputation to match wiki 9 years ago
rules doc: reference fixups 9 years ago
setting-up-ipsinline-for-linux doc: added setting up ips inline 9 years ago
.gitignore doc: update gitignore to ignore node_modules 9 years ago
Makefile docs: sample of sphinx docs 9 years ago
README.md doc: finish off the rules section 9 years ago
command-line-options.rst doc: reference fixups 9 years ago
conf.py doc: snort compatibility 9 years ago
convert.py doc: tls keywords 9 years ago
dropping-privileges.rst doc: reference fixups 9 years ago
index.rst doc: added output section (some fixes still to do) 9 years ago
initscripts.rst doc: added initscripts 9 years ago
make-sense-alerts.rst doc: making sense of alerts 9 years ago
oinkmaster.rst doc: oinkmaster 9 years ago
public-data-sets.rst doc: added public data sets with file 9 years ago
setting-up-ipsinline-for-linux.rst doc: reference fixups 9 years ago
snort-compatibility.rst doc: snort compatibility 9 years ago
what-is-suricata.rst doc: reference fixups 9 years ago

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Sphinx Document Generate is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Development Server

To help with writing documentation there is a development web server with live reload. To get run the live server you will first need npm installed then run the following:

npm install
gulp serve

Then point your browser at http://localhost:8000/_build/html/index.html

Any edits to .rst files should trigger a "make html" and cause your browser to refresh.