From bf244554bc2c9d65658fc145afde7085b39e583d Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 13 Apr 2024 23:30:31 -0700 Subject: [PATCH] Update docs --- docs/api.md | 1 + docs/usage.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/docs/api.md b/docs/api.md index 0e98b210d..5d459cfb6 100644 --- a/docs/api.md +++ b/docs/api.md @@ -140,6 +140,7 @@ document. Paperless only reports PDF metadata at this point. - `/api/documents//notes/`: Retrieve notes for a document. - `/api/documents//share_links/`: Retrieve share links for a document. +- `/api/documents//audit/`: Retrieve history of changes for a document. ## Authorization diff --git a/docs/usage.md b/docs/usage.md index 7cedb976a..c9003d35d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -472,6 +472,12 @@ Paperless-ngx supports 3 basic editing operations for PDFs (these operations can Note that rotation alters the Paperless-ngx _original_ file, which would, for example, invalidate a digital signature. +## Document History + +As of version 2.7, Paperless-ngx automatically records all changes to a document and records this in an audit log. The feature requires [`PAPERLESS_AUDIT_LOG_ENABLED`](configuration.md#PAPERLESS_AUDIT_LOG_ENABLED) be enabled, which it is by default as of version 2.7. +Changes to documents are visible under the "History" tab. Note that certain changes such as those made by workflows, record the 'actor' +as "System". + ## Best practices {#basic-searching} Paperless offers a couple tools that help you organize your document