]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/filestore(v1) - document force-filestore field
authorJason Ish <jason.ish@oisf.net>
Mon, 30 Sep 2019 17:13:53 +0000 (11:13 -0600)
committerVictor Julien <victor@inliniac.net>
Thu, 3 Oct 2019 13:48:11 +0000 (15:48 +0200)
doc/userguide/file-extraction/file-extraction.rst

index 05fb48118074a4ae8b7e4a521c05d1d0c9675330..b065a1698893ebb5fdeccc2cc88abe2cb5789331 100644 (file)
@@ -114,15 +114,16 @@ recommended.
 ::
 
   - file-store:
-      enabled: yes      # set to yes to enable
-      log-dir: files    # directory to store the files
-      force-magic: no   # force logging magic on all stored files
-      force-hash: [md5] # force logging of md5 checksums
-      stream-depth: 1mb # reassemble 1mb into a stream, set to no to disable
-      waldo: file.waldo # waldo file to store the file_id across runs
-      max-open-files: 0 # how many files to keep open (O means none)
-      write-meta: yes   # write a .meta file if set to yes
-      include-pid: yes  # include the pid in filenames if set to yes.
+      enabled: yes        # set to yes to enable
+      log-dir: files      # directory to store the files
+      force-magic: no     # force logging magic on all stored files
+      force-hash: [md5]   # force logging of md5 checksums
+      force-filestore: no # force storing of all files
+      stream-depth: 1mb   # reassemble 1mb into a stream, set to no to disable
+      waldo: file.waldo   # waldo file to store the file_id across runs
+      max-open-files: 0   # how many files to keep open (O means none)
+      write-meta: yes     # write a .meta file if set to yes
+      include-pid: yes    # include the pid in filenames if set to yes.
 
 Each file that is stored will have a name "file.<id>". The id will be reset and files will be overwritten unless the waldo option is used. A "file.<id>.meta" file is generated containing file metadata if write-meta is set to yes (default). If the include-pid option is set, the files will instead have a name "file.<pid>.<id>", and metafiles will be "file.<pid>.<id>.meta". Files will additionally have the suffix ".tmp" while they are open, which is only removed when they are finalized.