GuidesBasicsBackground Jobs

Background Jobs

ℹ️

Jobs and job management can be accessed on the /settings/jobs page

Stump runs certain operations as background jobs so the server remains responsive. Background jobs are usually long-running operations that may involve heavier CPU or IO work, such as scanning a library.

Scheduling

You can define recurring jobs that run automatically on a cron-based schedule:

  1. Library scan: Scans one or more libraries for new, updated, or missing media. You can target specific libraries or leave the selection empty to scan all libraries.

  2. Metadata retry: Retries previously failed or rate-limited metadata fetch attempts. You choose which statuses to retry (Rate limited, Failed, or both).

Cron

Schedules are defined using cron expressions. Stump supports 6-field cron expressions:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ second
β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€ minute
β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€ hour
β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€ day of month
β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€ month
β”‚ β”‚ β”‚ β”‚ β”‚ β”Œβ”€ day of week
β”‚ β”‚ β”‚ β”‚ β”‚ β”‚
* * * * * *

And provides a few default presets:

PresetCron expression
Every 6 hours0 0 */6 * * *
Every 12 hours0 0 */12 * * *
Daily at midnight0 0 0 * * *
Weekly on Sunday0 0 0 * * 0
Monthly on the 1st0 0 0 1 * *