From c478d7bb5d054c3ec79d2575ce394a8bafe55804 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 10 Aug 2026 10:57:39 -0700 Subject: [PATCH] And docs --- docs/usage.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/usage.md b/docs/usage.md index 13d80c70b..3f8724249 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -648,6 +648,19 @@ happened while it was still encrypted, that original version will likewise be mi **Current limitation**: Passwords are stored as a simple list without descriptions. To handle multiple PDF types with different passwords, create separate workflows for each use case. +##### Remote OCR {#workflow-action-remote-ocr} + +"Remote OCR" actions send the document to the configured remote OCR engine instead of processing it +locally. To use remote OCR selectively, set the [remote OCR mode](configuration.md#PAPERLESS_REMOTE_OCR_MODE) +to `workflow_only` then add this action to a workflow that matches only the documents you +want sent to the remote engine. See [Remote OCR](#remote-ocr) for the engine setup. The action only works with +a **Consumption Started** trigger. + +The action takes no options, its presence is what enables remote OCR for a matching document. + +If the remote engine is not configured, or does not support the document's file type, the document is +processed locally instead and a warning is written to the log. + #### Workflow placeholders Titles and webhook payloads can be generated by workflows using [Jinja templates](https://jinja.palletsprojects.com/en/3.1.x/templates/). @@ -1092,7 +1105,8 @@ 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. +unless a [remote OCR workflow action](#workflow-action-remote-ocr) enables it for them, so you can limit the remote +engine to particular documents. Setting the mode to `workflow_only` also allows the **Reprocess** actions to selectively use remote OCR for individual documents.