From eeb32ac77f4b3c0af318605e3bc5acd768614763 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 10 Feb 2026 14:57:14 +0000 Subject: [PATCH] docs: add documentation for Paperless custom field configuration Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com> --- docs/ConfigurationGuide.md | 9 +++++---- docs/UserGuide.md | 13 +++++++++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/ConfigurationGuide.md b/docs/ConfigurationGuide.md index 3498621c..b16a2636 100644 --- a/docs/ConfigurationGuide.md +++ b/docs/ConfigurationGuide.md @@ -212,10 +212,11 @@ SECURITY_HEADER_CSP_VALUE="default-src 'self'; script-src 'self' https://trusted ### Paperless NGX -| **Variable** | **Description** | -|-------------------------------|-----------------------------------------------------| -| `PAPERLESS_NGX_API_TOKEN` | API token for Paperless NGX. | -| `PAPERLESS_HOST` | Root URL for Paperless NGX (e.g. `https://paperless.example.com`). | +| **Variable** | **Description** | +|-----------------------------------|-----------------------------------------------------------------------------------------------------| +| `PAPERLESS_NGX_API_TOKEN` | API token for Paperless NGX. | +| `PAPERLESS_HOST` | Root URL for Paperless NGX (e.g. `https://paperless.example.com`). | +| `PAPERLESS_CUSTOM_FIELD_ABSENDER` | (Optional) Name of the custom field in Paperless-ngx to store the sender ("absender") information. If set, the extracted sender will be automatically set as a custom field after document upload. Example: `Absender` or `Sender` | ### Dropbox diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d464d182..6ab73be2 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -145,6 +145,19 @@ Depending on the system configuration, DocuElevate can perform: - **PDF Conversion** - Convert various file formats to PDF - **Document Distribution** - Store documents in Dropbox, Nextcloud, or Paperless NGX +### Paperless-ngx Integration + +If Paperless-ngx is configured, DocuElevate can automatically upload processed documents and set custom fields with extracted metadata: + +1. **Automatic Upload**: After processing, documents are automatically uploaded to Paperless-ngx +2. **Custom Fields**: If configured via `PAPERLESS_CUSTOM_FIELD_ABSENDER`, the sender ("absender") information extracted by AI will be automatically set as a custom field in Paperless +3. **Setup Requirements**: + - Create a custom field in Paperless-ngx (e.g., named "Absender" or "Sender") + - Set the `PAPERLESS_CUSTOM_FIELD_ABSENDER` environment variable to match your custom field name + - Ensure the custom field exists in Paperless before processing documents + +**Note**: The custom field feature requires that the field is already created in your Paperless-ngx instance. DocuElevate will look up the field by name and set its value automatically. + ## API Access For programmatic access, DocuElevate provides a comprehensive REST API: