Defaults to false.
- `PAPERLESS_CONSUMER_ENABLE_BARCODES=<bool>`
+ `PAPERLESS_CONSUMER_IGNORE_PATTERNS=<json>`
- : Enables the scanning and page separation based on detected barcodes.
- This allows for scanning and adding multiple documents per uploaded
- file, which are separated by one or multiple barcode pages.
+ : By default, paperless ignores certain files and folders in the
+ consumption directory, such as system files created by the Mac OS
+ or hidden folders some tools use to store data.
- For ease of use, it is suggested to use a standardized separation
- page, e.g. [here](https://www.alliancegroup.co.uk/patch-codes.htm).
+ This can be adjusted by configuring a custom json array with
+ patterns to exclude.
- If no barcodes are detected in the uploaded file, no page separation
- will happen.
+ For example, `.DS_STORE/*` will ignore any files found in a folder
+ named `.DS_STORE`, including `.DS_STORE/bar.pdf` and `foo/.DS_STORE/bar.pdf`
- The original document will be removed and the separated pages will
- be saved as pdf.
+ A pattern like `._*` will ignore anything starting with `._`, including:
+ `._foo.pdf` and `._bar/foo.pdf`
- Defaults to false.
+ Defaults to
+ `[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini", "@eaDir/*"]`.
- `PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT=<bool>`
+`PAPERLESS_CONSUMER_BARCODE_SCANNER=<string>`
+
+: Sets the barcode scanner used for barcode functionality.
+
+ Currently, "PYZBAR" (the default) or "ZXING" might be selected.
+ If you have problems that your Barcodes/QR-Codes are not detected
+ (especially with bad scan quality and/or small codes), try the other one.
+
+ zxing is not available on all platforms.
+
+ `PAPERLESS_PRE_CONSUME_SCRIPT=<filename>`
- : Whether TIFF image files should be scanned for barcodes. This will
- automatically convert any TIFF image(s) to pdfs for later
- processing. This only has an effect, if
- PAPERLESS_CONSUMER_ENABLE_BARCODES has been enabled.
-
- Defaults to false.
+ : After some initial validation, Paperless can trigger an arbitrary
+ script if you like before beginning consumption. This script will be provided
+ data for it to work with via the environment.
- `PAPERLESS_CONSUMER_BARCODE_STRING=PATCHT`
-
- : Defines the string to be detected as a separator barcode. If
- paperless is used with the PATCH-T separator pages, users shouldn't
- change this.
-
- Defaults to "PATCHT"
+ For more information, take a look at [pre-consumption script](/advanced_usage#pre-consume-script).
- `PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE=<bool>`
-
- : Enables the detection of barcodes in the scanned document and
- setting the ASN (archive serial number) if a properly formatted
- barcode is detected.
-
- The barcode must consist of a (configurable) prefix and the ASN
- to be set, for instance `ASN00123`.
-
- This option is compatible with barcode page separation, since
- pages will be split up before reading the ASN.
-
- If no ASN barcodes are detected in the uploaded file, no ASN will
- be set. If a barcode with an already existing ASN is detected, no ASN
- will be set either and a warning will be logged.
-
- Defaults to false.
-
- `PAPERLESS_CONSUMER_ASN_BARCODE_PREFIX=ASN`
-
- : Defines the prefix that is used to identify a barcode as an ASN
- barcode.
-
- Defaults to "ASN"
-
- `PAPERLESS_CONVERT_MEMORY_LIMIT=<num>`
-
- : On smaller systems, or even in the case of Very Large Documents, the
- consumer may explode, complaining about how it's "unable to extend
- pixel cache". In such cases, try setting this to a reasonably low
- value, like 32. The default is to use whatever is necessary to do
- everything without writing to disk, and units are in megabytes.
-
- For more information on how to use this value, you should search the
- web for "MAGICK_MEMORY_LIMIT".
-
- Defaults to 0, which disables the limit.
-
- `PAPERLESS_CONVERT_TMPDIR=<path>`
-
- : Similar to the memory limit, if you've got a small system and your
- OS mounts /tmp as tmpfs, you should set this to a path that's on a
- physical disk, like /home/your_user/tmp or something. ImageMagick
- will use this as scratch space when crunching through very large
- documents.
-
- For more information on how to use this value, you should search the
- web for "MAGICK_TMPDIR".
-
- Default is none, which disables the temporary directory.
+ The default is blank, which means nothing will be executed.
`PAPERLESS_POST_CONSUME_SCRIPT=<filename>`