From: Trenton Holmes <797416+stumpylog@users.noreply.github.com>
Date: Sat, 3 Dec 2022 03:21:19 +0000 (-0800)
Subject: Documents the configuration for NLTK related settings
X-Git-Tag: v1.11.0~1^2~30
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=95257d57238533b9e516e56c04746c8e9b89c03b;p=thirdparty%2Fpaperless-ngx.git

Documents the configuration for NLTK related settings
---

diff --git a/docs/configuration.md b/docs/configuration.md
index bcde72e5fb..d52663f5f8 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -170,6 +170,15 @@ details.
 
     Defaults to "`PAPERLESS_DATA_DIR`/log/".
 
+`PAPERLESS_NLTK_DIR=<path>`
+
+: This is where paperless will search for the data required for NLTK
+processing, if you are using it. If you are using the Docker image,
+this should not be changed, as the data is included in the image
+already.
+
+Defaults to `/usr/local/share/nltk_data`
+
 ## Logging
 
 `PAPERLESS_LOGROTATE_MAX_SIZE=<num>`
@@ -698,6 +707,16 @@ for details on how to set it.
 
     Defaults to UTC.
 
+`PAPERLESS_ENABLE_NLTK=<bool>`
+
+: Enables or disables the advanced natural language processing
+used during automatic classification. If disabled, paperless will
+still preform some basic text pre-processing before matching.
+
+See also `PAPERLESS_NLTK_DIR`.
+
+    Defaults to 1.
+
 ## Polling {#polling}
 
 `PAPERLESS_CONSUMER_POLLING=<num>`