chris/Axter-Stash
1
0
Fork 0
forked from Github/Axter-Stash
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
David Maisonave
2024-08-13 03:36:50 -04:00
committed by GitHub
parent d438d0909c
commit 90dc667b55
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
plugins/FileMonitor/README.md
View File

@@ -90,6 +90,11 @@ To configure the schedule or to add new task, edit the **task_scheduler** sectio
- `{"task" : "Auto Tag", "hours" : 24},`
- Starts a (**plugin**) task every 30 minutes.
- `{"task" : "Create Tags", "pluginId" : "pathParser", "minutes" : 30},`
- The frequency field does support days and seconds.
- seconds is mainly used for test purposes.
- The use of days is discourage, because it only works if FileMonitor is running for X many days non-stop.
- For example, if days is used with 30 days, FileMonitor would have to be running non-stop for 30 days before the task is activated. If it's restarted at any time durring the 30 days, the count down restarts.
- It's recommended to use weekday based syntax over using days, because many restarts can occur durring the week or month, and the task will still get started as long as FileMonitor is running durring the scheduled activation time.
- **weekday Based**
- Use the weekday based syntax for weekly and monthly schedules.
- Both weekly and monthly schedules must have a **weekday** field and a **time** field, which specifies the day of the week and the time to start the task.