From ef4009e94f3c81867100fbb5653a1ddfbbac5fd7 Mon Sep 17 00:00:00 2001 From: jonaswinkler <17569239+jonaswinkler@users.noreply.github.com> Date: Sun, 21 Feb 2021 13:35:47 +0100 Subject: [PATCH] documentation --- docs/changelog.rst | 4 ++-- docs/configuration.rst | 9 +++++++++ docs/setup.rst | 3 +++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index f5a353adb..57ffbc40d 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -10,12 +10,12 @@ paperless-ng 1.2.0 * Changes to the OCRmyPDF integration - * Added support for deskewing and automatic rotation of incorrectly rotated pages. + * Added support for deskewing and automatic rotation of incorrectly rotated pages. This is disabled by default, see :ref:`configuration-ocr`. * Better support for encrypted files. * Better support for various other PDF files: Paperless will now attempt to force OCR with safe options when OCR fails with the configured options. * Added an explicit option to skip cleaning with ``unpaper``. -* Download multiple selected document. +* Download multiple selected documents as a zip archive. * The document list now remembers the current page. diff --git a/docs/configuration.rst b/docs/configuration.rst index a558ea79d..1c1763392 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -244,6 +244,8 @@ PAPERLESS_OCR_MODE= The default is ``skip``, which only performs OCR when necessary and always creates archived documents. + Read more about this in the `OCRmyPDF documentation `_. + PAPERLESS_OCR_CLEAN= Tells paperless to use ``unpaper`` to clean any input document before sending it to tesseract. This uses more resources, but generally results @@ -256,12 +258,19 @@ PAPERLESS_OCR_CLEAN= Defaults to ``clean``. + .. note:: + + ``clean-final`` is incompatible with ocr mode ``redo``. + PAPERLESS_OCR_DESKEW= Tells paperless to correct skewing (slight rotation of input images mainly due to improper scanning) Defaults to ``false``, which disables this feature. + .. note:: + + Deskewing is incompatible with ocr mode ``redo``. PAPERLESS_OCR_ROTATE_PAGES= Tells paperless to correct page rotation (90°, 180° and 270° rotation). diff --git a/docs/setup.rst b/docs/setup.rst index f6d6b47bc..69cb2bc97 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -774,6 +774,9 @@ configuring some options in paperless can help improve performance immensely: your documents before feeding them into paperless. Some scanners are able to do this! You might want to even specify ``skip_noarchive`` to skip archive file generation for already ocr'ed documents entirely. +* If you want to perform OCR on the the device, consider using ``PAPERLESS_OCR_CLEAN=none``. + This will speed up OCR times and use less memory at the expense of slightly worse + OCR results. * Set ``PAPERLESS_OPTIMIZE_THUMBNAILS`` to 'false' if you want faster consumption times. Thumbnails will be about 20% larger. * If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to