From 95257d57238533b9e516e56c04746c8e9b89c03b Mon Sep 17 00:00:00 2001 From: Trenton Holmes <797416+stumpylog@users.noreply.github.com> Date: Fri, 2 Dec 2022 19:21:19 -0800 Subject: [PATCH] Documents the configuration for NLTK related settings --- docs/configuration.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index bcde72e5f..d52663f5f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -170,6 +170,15 @@ details. Defaults to "`PAPERLESS_DATA_DIR`/log/". +`PAPERLESS_NLTK_DIR=` + +: 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=` @@ -698,6 +707,16 @@ for details on how to set it. Defaults to UTC. +`PAPERLESS_ENABLE_NLTK=` + +: 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=`