diff --git a/docs/configuration.md b/docs/configuration.md index 16d11e6b5..5fea76e20 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2047,6 +2047,18 @@ password. All of these options come from their similarly-named [Django settings] Defaults to None. +#### [`PAPERLESS_REMOTE_OCR_MODE=`](#PAPERLESS_REMOTE_OCR_MODE) {#PAPERLESS_REMOTE_OCR_MODE} + +: Which documents are sent to the remote OCR engine. + + - `always`: every document of a supported file type is sent to the remote + engine, bypassing the local OCR engine. + - `workflow_only`: documents are processed locally unless a workflow + explicitly enables remote OCR for them, letting you use the remote engine + selectively. + + Defaults to "always". + ## AI {#ai} #### [`PAPERLESS_AI_ENABLED=`](#PAPERLESS_AI_ENABLED) {#PAPERLESS_AI_ENABLED} diff --git a/docs/usage.md b/docs/usage.md index 846bbcce6..76cfc66a7 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1090,6 +1090,10 @@ settings can be supplied as environment variables or via **Application Configura Additionally, when using a commercial service with this feature, consider both potential costs as well as any associated file size or page limitations (e.g. with a free tier). +By default, every document of a supported file type is sent to the remote engine. To use it more selectively, set the +[remote OCR mode](configuration.md#PAPERLESS_REMOTE_OCR_MODE) to `workflow_only`. Documents are then processed locally +unless a workflow explicitly enables remote OCR for them, so you can limit the remote engine to particular documents. + ## Architecture Paperless-ngx consists of the following components: