lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename trash dir setting, clarify docs

Browse Source
This commit is contained in:
shamoon
2024-06-11 08:32:43 -07:00
parent 141d4f8456
commit 73345b3668
7 changed files with 23 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuration.md
View File

@@ -219,10 +219,10 @@ database, classification model, etc).
Defaults to "../data/", relative to the "src" directory.
#### [`PAPERLESS_TRASH_DIR=<path>`](#PAPERLESS_TRASH_DIR) {#PAPERLESS_TRASH_DIR}
#### [`PAPERLESS_EMPTY_TRASH_DIR=<path>`](#PAPERLESS_EMPTY_TRASH_DIR) {#PAPERLESS_EMPTY_TRASH_DIR}
: Instead of removing deleted documents, they are moved to this
directory.
: When documents are deleted (e.g. after emptying the trash) the original files will be moved here
instead of being removed from the filesystem. Only the original version is kept.
This must be writeable by the user running paperless. When running
inside docker, ensure that this path is within a permanent volume
@@ -230,7 +230,9 @@ directory.
Note that the directory must exist prior to using this setting.
Defaults to empty (i.e. really delete documents).
Defaults to empty (i.e. really delete files).
This setting was previously named PAPERLESS_TRASH_DIR.
#### [`PAPERLESS_MEDIA_ROOT=<path>`](#PAPERLESS_MEDIA_ROOT) {#PAPERLESS_MEDIA_ROOT}

5
docs/usage.md
View File

@@ -482,8 +482,9 @@ as "System".
When you first delete a document it is moved to the 'trash' until either it is explicitly deleted or it is automatically removed after a set amount of time has passed.
You can set how long documents remain in the trash before being automatically deleted with [`EMPTY_TRASH_DELAY`](configuration.md#EMPTY_TRASH_DELAY), which defaults
to 30 days. Additionally you may configure a directory where deleted documents are moved to when they are finally deleted with [`PAPERLESS_TRASH_DIR`](configuration.md#PAPERLESS_TRASH_DIR).
Note that the trash directory only stores the original file, the archive version and all database information is permanently removed once a document is fully deleted.
to 30 days. Additionally you may configure a directory where deleted files are moved to when they are finally deleted (e.g. the trash is emptied) with
[`PAPERLESS_EMPTY_TRASH_DIR`](configuration.md#PAPERLESS_EMPTY_TRASH_DIR). Note that the empty trash directory only stores the original file, the archive file and all database
information is permanently removed once a document is fully deleted.
## Best practices {#basic-searching}