Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/administration/scheduled-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Every scheduled task takes a standard 5-field cron expression:
- `*/30 * * * *`: every 30 minutes
- `0 2 * * 0`: 2 AM every Sunday

Set the env var and restart the container. The scheduler picks up the new schedule as soon as RomM is back.
Set the env var and restart the container. The scheduler picks up the new schedule as soon as RomM is back. An expression that doesn't parse leaves the task unscheduled, and the startup log names the task and the rejected expression.

## Enabling a scheduled task

Most tasks have an `ENABLE_*` environment variable, like `ENABLE_SCHEDULED_UPDATE_LAUNCHBOX_METADATA=true` which enables the LaunchBox sync. Set both the enable var and its cron var, since a task with an empty cron string has nothing to schedule and stays unscheduled even when enabled.

Unlike other tasks, **build recommendations index** ships enabled, because the [recommendation](../using/recommendations.md) sections read that index and similar games sits empty without it. Setting `ENABLE_SCHEDULED_BUILD_RECOMMENDATIONS=false` stops the nightly rebuild, but doesn't hide either section. Users turn those off in their own settings.

The housekeeping tasks (netplay cleanup, upload tmp cleanup, ZIP cache cleanup) are always on and have no env vars. Check the [env var reference](../reference/environment-variables.md) for the full list.
The housekeeping tasks (netplay cleanup, upload tmp cleanup, ZIP cache cleanup, sync session cleanup) also ship enabled. Each has an `ENABLE_SCHEDULED_CLEANUP_*` var to turn it off and a matching `SCHEDULED_CLEANUP_*_CRON` to move it. With upload tmp cleanup off, abandoned chunked uploads stay in `tmp/uploads` under `ROMM_TMP_PATH` (or the resources folder when that's unset) until you delete them. Check the [env var reference](../reference/environment-variables.md) for the full list.

## Triggering a task manually

Expand Down