Skip to content

Commit aa43377

Browse files
author
Ryan
committed
docs: manual documentation
1 parent 236670e commit aa43377

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/content/schedules/configuration.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,14 @@ Note: It works only on Windows and makes sense only with `user_logged_on` permis
201201

202202
Note: The behavior of `conhost.exe` varies between Windows versions. It has been confirmed to work on Windows 11 (24H2) but not on Windows 10 (1607).
203203

204+
## schedule-start-when-available
205+
206+
When set to `true`, Windows Task Scheduler will start the task as soon as possible after a scheduled start is missed. This is useful when the computer might be asleep or off during the scheduled time.
207+
208+
For example, if a backup is scheduled for 3:00 AM but the computer is off, enabling this option will run the backup when the computer is next available.
209+
210+
Note: This option only works on Windows.
211+
204212
## Example
205213

206214
Here's an example of a scheduling configuration:

docs/content/schedules/task_scheduler/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,16 @@ It's easy to spot a terminal window opened with Administrator privileges:
3434

3535
> [!IMPORTANT]
3636
> Running the schedule command might cause Windows to delete _resticprofile.exe_, treating it as a threat.
37+
38+
## Start when available
39+
40+
If your computer might be asleep or off during a scheduled backup time, you can enable `schedule-start-when-available` to run the task as soon as the computer becomes available.
41+
42+
```yaml
43+
profile:
44+
backup:
45+
schedule: "03:00"
46+
schedule-start-when-available: true
47+
```
48+
49+
This sets the "Start the task as soon as possible after a scheduled start is missed" option in Windows Task Scheduler.

0 commit comments

Comments
 (0)