Skip to content

A community-supported supercharged document management system: scan, index and archive all your documents

Documentation: Document missing workflows env variable and complete diagram (#11554)

Jan Kleinee770ff572eee
diff --git a/docs/configuration.md b/docs/configuration.md
index 0ae474805..9b4694b63 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1054,12 +1054,22 @@ should be a valid crontab(5) expression describing when to run.
#### [`PAPERLESS_SANITY_TASK_CRON=<cron expression>`](#PAPERLESS_SANITY_TASK_CRON) {#PAPERLESS_SANITY_TASK_CRON}
-: Configures the scheduled sanity checker frequency.
+: Configures the scheduled sanity checker frequency. The value should be a
+valid crontab(5) expression describing when to run.
: If set to the string "disable", the sanity checker will not run automatically.
Defaults to `30 0 * * sun` or Sunday at 30 minutes past midnight.
+#### [`PAPERLESS_WORKFLOW_SCHEDULED_TASK_CRON=<cron expression>`](#PAPERLESS_WORKFLOW_SCHEDULED_TASK_CRON) {#PAPERLESS_WORKFLOW_SCHEDULED_TASK_CRON}
+
+: Configures the scheduled workflow check frequency. The value should be a
+valid crontab(5) expression describing when to run.
+
+: If set to the string "disable", scheduled workflows will not run.
+
+ Defaults to `5 */1 * * *` or every hour at 5 minutes past the hour.
+
#### [`PAPERLESS_ENABLE_COMPRESSION=<bool>`](#PAPERLESS_ENABLE_COMPRESSION) {#PAPERLESS_ENABLE_COMPRESSION}
: Enables compression of the responses from the webserver.
diff --git a/docs/usage.md b/docs/usage.md
index cac2c964f..339dbddde 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -443,6 +443,10 @@ flowchart TD
'Updated'
trigger(s)"}
+ scheduled{"Documents
+ matching
+ trigger(s)"}
+
A[New Document] --> consumption
consumption --> |Yes| C[Workflow Actions Run]
consumption --> |No| D
@@ -455,6 +459,11 @@ flowchart TD
updated --> |Yes| J[Workflow Actions Run]
updated --> |No| K
J --> K[Document Saved]
+ L[Scheduled Task Check<br/>hourly at :05] --> M[Get All Scheduled Triggers]
+ M --> scheduled
+ scheduled --> |Yes| N[Workflow Actions Run]
+ scheduled --> |No| O[Document Saved]
+ N --> O
```
#### Filters {#workflow-trigger-filters}