mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	Adds documentation of how to configure tasks
This commit is contained in:
		@@ -713,10 +713,45 @@ for details on how to set it.
 | 
			
		||||
used during automatic classification. If disabled, paperless will
 | 
			
		||||
still preform some basic text pre-processing before matching.
 | 
			
		||||
 | 
			
		||||
See also `PAPERLESS_NLTK_DIR`.
 | 
			
		||||
: See also `PAPERLESS_NLTK_DIR`.
 | 
			
		||||
 | 
			
		||||
    Defaults to 1.
 | 
			
		||||
 | 
			
		||||
`PAPERLESS_EMAIL_TASK_CRON=<cron expression>`
 | 
			
		||||
 | 
			
		||||
: Configures the scheduled email fetching frequency. The value
 | 
			
		||||
should be a valid crontab(5) expression describing when to run.
 | 
			
		||||
 | 
			
		||||
: If set to the string "disable", no emails will be fetched automatically.
 | 
			
		||||
 | 
			
		||||
    Defaults to `*/10 * * * *` or every ten minutes.
 | 
			
		||||
 | 
			
		||||
`PAPERLESS_TRAIN_TASK_CRON=<cron expression>`
 | 
			
		||||
 | 
			
		||||
: Configures the scheduled automatic classifier training frequency. The value
 | 
			
		||||
should be a valid crontab(5) expression describing when to run.
 | 
			
		||||
 | 
			
		||||
: If set to the string "disable", the classifier will not be trained automatically.
 | 
			
		||||
 | 
			
		||||
    Defaults to `5 */1 * * *` or every hour at 5 minutes past the hour.
 | 
			
		||||
 | 
			
		||||
`PAPERLESS_INDEX_TASK_CRON=<cron expression>`
 | 
			
		||||
 | 
			
		||||
: Configures the scheduled search index update frequency. The value
 | 
			
		||||
should be a valid crontab(5) expression describing when to run.
 | 
			
		||||
 | 
			
		||||
: If set to the string "disable", the search index will not be automatically updated.
 | 
			
		||||
 | 
			
		||||
    Defaults to `0 0 * * *` or daily at midnight.
 | 
			
		||||
 | 
			
		||||
`PAPERLESS_SANITY_TASK_CRON=<cron expression>`
 | 
			
		||||
 | 
			
		||||
: Configures the scheduled sanity checker frequency.
 | 
			
		||||
 | 
			
		||||
: 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.
 | 
			
		||||
 | 
			
		||||
## Polling {#polling}
 | 
			
		||||
 | 
			
		||||
`PAPERLESS_CONSUMER_POLLING=<num>`
 | 
			
		||||
 
 | 
			
		||||
@@ -191,7 +191,7 @@ different means. These are as follows:
 | 
			
		||||
    them further.
 | 
			
		||||
 | 
			
		||||
Paperless is set up to check your mails every 10 minutes. This can be
 | 
			
		||||
configured on the 'Scheduled tasks' page in the admin.
 | 
			
		||||
configured via `PAPERLESS_EMAIL_TASK_CRON` (see [software tweaks](/configuration#software_tweaks))
 | 
			
		||||
 | 
			
		||||
### REST API
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user