mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	Reworks documentation on the max pixels setting
This commit is contained in:
		@@ -424,14 +424,23 @@ PAPERLESS_OCR_IMAGE_DPI=<num>
 | 
			
		||||
    the produced PDF documents are A4 sized.
 | 
			
		||||
 | 
			
		||||
PAPERLESS_OCR_MAX_IMAGE_PIXELS=<num>
 | 
			
		||||
    Paperless will not OCR images that have more pixels than this limit.
 | 
			
		||||
    This is intended to prevent decompression bombs from overloading paperless.
 | 
			
		||||
    Increasing this limit is desired if you face a DecompressionBombError despite
 | 
			
		||||
    the concerning file not being malicious; this could e.g. be caused by invalidly
 | 
			
		||||
    recognized metadata.
 | 
			
		||||
    If you have enough resources or if you are certain that your uploaded files
 | 
			
		||||
    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.
 | 
			
		||||
    Paperless will raise a warning when OCRing images which are over this limit and
 | 
			
		||||
    will not OCR images which are more than twice this limit.  Note this does not
 | 
			
		||||
    prevent the document from being consumed, but could result in missing text content.
 | 
			
		||||
 | 
			
		||||
    If unset, will default to the value determined by
 | 
			
		||||
    `Pillow <https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.MAX_IMAGE_PIXELS>`_.
 | 
			
		||||
 | 
			
		||||
    .. 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>
 | 
			
		||||
    OCRmyPDF offers many more options. Use this parameter to specify any
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user