]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Docs
authorshamoon <4887959+shamoon@users.noreply.github.com>
Thu, 6 Nov 2025 01:55:06 +0000 (17:55 -0800)
committershamoon <4887959+shamoon@users.noreply.github.com>
Thu, 6 Nov 2025 01:55:06 +0000 (17:55 -0800)
docs/configuration.md
docs/usage.md

index 51c00d1a5e231ef5f6eb6afa01441f24472b5314..8b13c3a878808bdd1f8f508d41ce0d2efd98e1ac 100644 (file)
@@ -1593,6 +1593,16 @@ processing. This only has an effect if
 
     Defaults to `0 1 * * *`, once per day.
 
+## Share links
+
+#### [`PAPERLESS_SHARE_LINK_BUNDLE_CLEANUP_CRON=<cron expression>`](#PAPERLESS_SHARE_LINK_BUNDLE_CLEANUP_CRON) {#PAPERLESS_SHARE_LINK_BUNDLE_CLEANUP_CRON}
+
+: Controls how often Paperless-ngx removes expired share link bundles (and their generated ZIP archives).
+
+: If set to the string "disable", expired bundles are not cleaned up automatically.
+
+    Defaults to `0 2 * * *`, once per day at 02:00.
+
 ## Binaries
 
 There are a few external software packages that Paperless expects to
index d902f6814f94af1c42e1c54a9ee2efa890aadf03..78495bc6ad91ea0406f620318bfdfe1d48ec26e0 100644 (file)
@@ -286,12 +286,14 @@ or using [email](#workflow-action-email) or [webhook](#workflow-action-webhook)
 
 ### Share Links
 
-"Share links" are shareable public links to files and can be created and managed under the 'Send' button on the document detail screen.
+"Share links" are public links to files (or an archive of files) and can be created and managed under the 'Send' button on the document detail screen or from the bulk editor.
 
--   Share links do not require a user to login and thus link directly to a file.
+-   Share links do not require a user to login and thus link directly to a file or bundled download.
 -   Links are unique and are of the form `{paperless-url}/share/{randomly-generated-slug}`.
 -   Links can optionally have an expiration time set.
 -   After a link expires or is deleted users will be redirected to the regular paperless-ngx login.
+-   From the document detail screen you can create a share link for that single document.
+-   From the bulk editor you can create a **share link bundle** for any selection. Paperless-ngx prepares a ZIP archive in the background and exposes a single share link. You can revisit the "Manage share link bundles" dialog to monitor progress, retry failed bundles, or delete links.
 
 !!! tip