From a5c8b82da5b392c812a05289c0d13aeec843d644 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nathana=C3=ABl=20Houn?= Date: Tue, 20 Oct 2026 00:00:28 +0200 Subject: [PATCH] Documentation: add scratch_dir setting (#14498) --- docs/configuration.md | 9 +++++++++ paperless.conf.example | 1 + 2 files changed, 10 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 3257a815c..4c7d2059d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -370,6 +370,15 @@ instead of being removed from the filesystem. Only the original version is kept. This setting was previously named PAPERLESS_TRASH_DIR. +#### [`PAPERLESS_SCRATCH_DIR=`](#PAPERLESS_SCRATCH_DIR) {#PAPERLESS_SCRATCH_DIR} + +: This folder is used as a temporary workspace for multiple paperless operations, including +consuming documents, editing, and the document exporter. + + This must be writeable by the user running paperless. + + Defaults to "/tmp/paperless". + #### [`PAPERLESS_MEDIA_ROOT=`](#PAPERLESS_MEDIA_ROOT) {#PAPERLESS_MEDIA_ROOT} : This is where your documents and thumbnails are stored. diff --git a/paperless.conf.example b/paperless.conf.example index e2cedf63c..635e78b35 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -16,6 +16,7 @@ #PAPERLESS_CONSUMPTION_DIR=../consume #PAPERLESS_DATA_DIR=../data #PAPERLESS_EMPTY_TRASH_DIR= +#PAPERLESS_SCRATCH_DIR=/tmp/paperless #PAPERLESS_MEDIA_ROOT=../media #PAPERLESS_STATICDIR=../static #PAPERLESS_FILENAME_FORMAT=