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/userguide
Julian 0179514576 redis: support for rpush in list mode
This adds a new redis mode rpush. Also more consistent config keywords orientated at the redis command: lpush and publish.
Keeping list and channel config keywords for backwards compatibility. Removed unnecessary checks.
8 years ago
..
_static doc: rename from "sphinx" to "userguide" 9 years ago
capture-hardware doc: napatech formatting fixes 8 years ago
configuration redis: support for rpush in list mode 8 years ago
file-extraction doc: fix sphinx warnings 9 years ago
licenses doc: add GPL and CC licenses 9 years ago
manpages doc: manpage: add bugs and notes section 9 years ago
output redis: support for rpush in list mode 8 years ago
partials doc: break out command line options into a common doc 9 years ago
performance doc: fix sphinx warnings 9 years ago
reputation docs: fix statement about flow:to_server 8 years ago
rule-management doc: move rule reload and adding rules into rule-management 9 years ago
rules doc: rephrase nocase placement explanation 8 years ago
setting-up-ipsinline-for-linux doc: rename from "sphinx" to "userguide" 9 years ago
.gitignore doc: hook sphinx into build 9 years ago
Makefile.am doc: only build pdf on dist if pdflatex is installed 8 years ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md doc: rename from "sphinx" to "userguide" 9 years ago
acknowledgements.rst doc: rename from "sphinx" to "userguide" 9 years ago
command-line-options.rst doc: break out command line options into a common doc 9 years ago
conf.py doc: exclude docs in partials/ from reference errors 9 years ago
convert.py doc: rename from "sphinx" to "userguide" 9 years ago
index.rst doc: add rule-management chapter 9 years ago
initscripts.rst doc: rename from "sphinx" to "userguide" 9 years ago
install.rst doc: improve install doc, configure 9 years ago
make-sense-alerts.rst doc: rename from "sphinx" to "userguide" 9 years ago
public-data-sets.rst doc: rename from "sphinx" to "userguide" 9 years ago
setting-up-ipsinline-for-linux.rst doc: rename from "sphinx" to "userguide" 9 years ago
unix-socket.rst doc: bring in unix socket interaction from wiki 9 years ago
what-is-suricata.rst doc: update what is suricata section 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.