paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify behavior of consumption dir in docs

Browse Source
This commit is contained in:
shamoon 2023-06-06 13:28:43 -07:00
parent df948065a3
commit 67744c877d
2 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/faq.md
View 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 files around manually. This folder is meant to be entirely managed by
docker and paperless. 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? ## 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. **A:** Your documents are stored as plain files inside the media folder.

17
docs/usage.md
View File

@ -69,7 +69,9 @@ following operations on your documents:
No matter which options you choose, Paperless will always store the No matter which options you choose, Paperless will always store the
original document that it found in the consumption directory or in the original document that it found in the consumption directory or in the
mail and will never overwrite that document. Archived versions are 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 ### 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 them in the consumption directory. The consumer waits patiently, looking
for new additions to this directory. When it finds them, for new additions to this directory. When it finds them,
the consumer goes about the process of parsing them with the OCR, 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 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 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 [Proftpd](http://www.proftpd.org/) or a Windows folder share with
[Samba](https://www.samba.org/). [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 ### Web UI Upload
The dashboard has a file drop field to upload documents to paperless. The dashboard has a file drop field to upload documents to paperless.