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.
637a7c8e55
This takes the form of an option to add the pid of the process to file names. Additionally, it adds a suffix to the file name to indicate it is not finalized. Adding the pid to the file name reduces the likelihood that a file is overwritten when suricata is unexpectedly killed. The number in the waldo file is only written out during a clean shutdown. In the event of an improper shutdown, extracted files will be written using the old number and existing files with the same name will be overwritten. Writes extracted files and their metadata to a temporary file suffixed with '.tmp'. Renames the files when they are completely done being written. As-is there is no way to know that a file on disk is still being written to by suricata. |
7 years ago | |
|---|---|---|
| .. | ||
| _static | 9 years ago | |
| capture-hardware | 8 years ago | |
| configuration | 8 years ago | |
| file-extraction | 7 years ago | |
| licenses | 9 years ago | |
| manpages | 9 years ago | |
| output | 8 years ago | |
| partials | 9 years ago | |
| performance | 8 years ago | |
| reputation | 8 years ago | |
| rule-management | 9 years ago | |
| rules | 7 years ago | |
| setting-up-ipsinline-for-linux | 9 years ago | |
| .gitignore | 9 years ago | |
| Makefile.am | 8 years ago | |
| Makefile.sphinx | 9 years ago | |
| README.md | 9 years ago | |
| acknowledgements.rst | 9 years ago | |
| command-line-options.rst | 9 years ago | |
| conf.py | 9 years ago | |
| convert.py | 9 years ago | |
| index.rst | 9 years ago | |
| initscripts.rst | 9 years ago | |
| install.rst | 8 years ago | |
| make-sense-alerts.rst | 9 years ago | |
| public-data-sets.rst | 8 years ago | |
| setting-up-ipsinline-for-linux.rst | 9 years ago | |
| unix-socket.rst | 8 years ago | |
| what-is-suricata.rst | 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.