]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Document ASN barcode settings
authorPeter Kappelt <kappelt.peter@gmail.com>
Mon, 16 Jan 2023 09:14:17 +0000 (10:14 +0100)
committerTrenton H <797416+stumpylog@users.noreply.github.com>
Tue, 24 Jan 2023 17:43:52 +0000 (09:43 -0800)
docs/configuration.md

index 873db795ee333f401af166a2dc9594a52fbb1bdd..f58da167b7e6bb44897cdd67d4a1fe7931655c92 100644 (file)
@@ -856,6 +856,31 @@ change this.
 
     Defaults to "PATCHT"
 
+`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