openpanel/documentation/docs/panel/advanced/cronjobs.md
2024-02-05 10:23:04 +01:00

55 lines
1.8 KiB
Markdown

---
sidebar_position: 1
---
# CronJobs
A cron job is a Linux command used to schedule tasks for future execution. It allows you to automate repetitive tasks, such as sending notifications or running scripts at specific intervals.
![cronjobs_list.png](/img/panel/v1/advanced/cronjobs_list.png)
On the CronJobs page you can view currently scheduled tasks, create new, edit or delete them.
:::info
The TimeZone setting is handy for running scheduled [cronjobs](/docs/panel/advanced/cronjobs) in your local timezone.
:::
## Add a CronJob
To create a new cronjob click on the 'Create CronJob' button and in the new form set the script to be executed and desired schedule.
![cronjobs_new.png](/img/panel/v1/advanced/cronjobs_new.png)
The first field allows you to set a predefined schedule:
- Once per minute
- Once per 5 minutes
- Twice per hour
- Once per hour
- Twice per day
- Once per day
- Once per week
- Twice per month (every 1st and 15th of the month)
- Once per month
- Once per year
![cronjobs_new_predefined.png](/img/panel/v1/advanced/cronjobs_new_predefined.png)
## Edit a CronJob
To edit an existing cronjob, click on the 'Edit' button next to it. This action will open a modal displaying the current cronjob as saved in the crontab file.
![cronjobs_edit.png](/img/panel/v1/advanced/cronjobs_edit.png)
To modify the schedule for when the script is executed, update the first part of the script. You can configure the schedule using a tool such as https://crontab.guru/
To alter the script that is executed, modify the part following the cron schedule.
## Delete a CronJob
To delete a cronjob, click on the 'Delete' button next to it. This action will open a modal asking you to confirm the deletion.
![cronjobs_delete.png](/img/panel/v1/advanced/cronjobs_delete.png)