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

Reworks documentation on the max pixels setting

Browse Source
This commit is contained in:
Trenton Holmes 2022-05-23 10:44:33 -07:00
parent fc26fe0ac0
commit 985b774378
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/configuration.rst
View File

@ -424,14 +424,23 @@ PAPERLESS_OCR_IMAGE_DPI=<num>
the produced PDF documents are A4 sized. the produced PDF documents are A4 sized.
PAPERLESS_OCR_MAX_IMAGE_PIXELS=<num> PAPERLESS_OCR_MAX_IMAGE_PIXELS=<num>
Paperless will not OCR images that have more pixels than this limit. Paperless will raise a warning when OCRing images which are over this limit and
This is intended to prevent decompression bombs from overloading paperless. will not OCR images which are more than twice this limit. Note this does not
Increasing this limit is desired if you face a DecompressionBombError despite prevent the document from being consumed, but could result in missing text content.
the concerning file not being malicious; this could e.g. be caused by invalidly
recognized metadata. If unset, will default to the value determined by
If you have enough resources or if you are certain that your uploaded files `Pillow <https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.MAX_IMAGE_PIXELS>`_.
are not malicious you can increase this value to your needs.
The default value is 256000000, an image with more pixels than that would not be parsed. .. note::
Increasing this limit could cause Paperless to consume additional resources
when consuming a file. Be sure you have sufficient system resources.
.. caution::
The limit is intended to prevent malicious files from consuming system resources
and causing crashes and other errors. Only increase this value if you are certain
your documents are not malicious and you need the text which was not OCRed
PAPERLESS_OCR_USER_ARGS=<json> PAPERLESS_OCR_USER_ARGS=<json>
OCRmyPDF offers many more options. Use this parameter to specify any OCRmyPDF offers many more options. Use this parameter to specify any