]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Clarify behavior of consumption dir in docs 3552/head
authorshamoon <4887959+shamoon@users.noreply.github.com>
Tue, 6 Jun 2023 20:28:43 +0000 (13:28 -0700)
committershamoon <4887959+shamoon@users.noreply.github.com>
Tue, 6 Jun 2023 20:37:54 +0000 (13:37 -0700)
docs/faq.md
docs/usage.md

index ef59d685f08f27a5fccdca115da918ef8d28c14d..d9a4e5f5371c124c8029a8cd1dd4f592aaa0d349 100644 (file)
@@ -27,6 +27,12 @@ system. On Linux, chances are high that this location is
     files around manually. This folder is meant to be entirely managed by
     docker and paperless.
 
+!!! note
+
+    Files consumed from the consumption directory are re-created inside
+    this media directory and are removed from the consumption directory
+    itself.
+
 ## Let's say I want to switch tools in a year. Can I easily move to other systems?
 
 **A:** Your documents are stored as plain files inside the media folder.
index 140695b95404abc427f1beb834998b763065dcbf..5509c69dac0529490d09d1273c678e49555f93c3 100644 (file)
@@ -69,7 +69,9 @@ following operations on your documents:
     No matter which options you choose, Paperless will always store the
     original document that it found in the consumption directory or in the
     mail and will never overwrite that document. Archived versions are
-    stored alongside the original versions.
+    stored alongside the original versions. Any files found in the
+    consumption directory will stored inside the Paperless-ngx file
+    structure and will not be retained in the consumption directory.
 
 ### The consumption directory
 
@@ -77,7 +79,9 @@ The primary method of getting documents into your database is by putting
 them in the consumption directory. The consumer waits patiently, looking
 for new additions to this directory. When it finds them,
 the consumer goes about the process of parsing them with the OCR,
-indexing what it finds, and storing it in the media directory.
+indexing what it finds, and storing it in the media directory. You should
+think of this folder as a temporary location, as files will be re-created
+inside Paperless-ngx and removed from the consumption folder.
 
 Getting stuff into this directory is up to you. If you're running
 Paperless on your local computer, you might just want to drag and drop
@@ -88,6 +92,15 @@ Typically, you're looking at an FTP server like
 [Proftpd](http://www.proftpd.org/) or a Windows folder share with
 [Samba](https://www.samba.org/).
 
+!!! warning
+
+    Files found in the consumption directory that are consumed will be
+    removed from the consumption directory and stored inside the
+    Paperless-ngx file structure using any settings / storage paths
+    you have specified. This action is performed as safely as possible
+    but this means it is expected that files in the consumption
+    directory will no longer exist (there) after being consumed.
+
 ### Web UI Upload
 
 The dashboard has a file drop field to upload documents to paperless.