mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-07-28 18:24:38 -05:00
Feature: documents trash aka soft delete (#6944)
This commit is contained in:
@@ -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}
|
||||
|
||||
@@ -1362,6 +1364,20 @@ processing. This only has an effect if
|
||||
|
||||
Defaults to false.
|
||||
|
||||
## Trash
|
||||
|
||||
#### [`EMPTY_TRASH_DELAY=<num>`](#EMPTY_TRASH_DELAY) {#EMPTY_TRASH_DELAY}
|
||||
|
||||
: Sets how long in days documents remain in the 'trash' before they are permanently deleted.
|
||||
|
||||
Defaults to 30 days, minimum of 1 day.
|
||||
|
||||
#### [`PAPERLESS_EMPTY_TRASH_TASK_CRON=<cron expression>`](#PAPERLESS_EMPTY_TRASH_TASK_CRON) {#PAPERLESS_EMPTY_TRASH_TASK_CRON}
|
||||
|
||||
: Configures the schedule to empty the trash of expired deleted documents.
|
||||
|
||||
Defaults to `0 1 * * *`, once per day.
|
||||
|
||||
## Binaries
|
||||
|
||||
There are a few external software packages that Paperless expects to
|
||||
|
@@ -478,6 +478,15 @@ As of version 2.7, Paperless-ngx automatically records all changes to a document
|
||||
Changes to documents are visible under the "History" tab. Note that certain changes such as those made by workflows, record the 'actor'
|
||||
as "System".
|
||||
|
||||
## Document Trash
|
||||
|
||||
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. Until the file is actually deleted (e.g. the trash is emptied), all files and database content remains intact and can be restored at any point up until that time.
|
||||
|
||||
Additionally you may configure a directory where deleted files are moved to when they 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}
|
||||
|
||||
Paperless offers a couple tools that help you organize your document
|
||||
|
Reference in New Issue
Block a user