How to use our schedules
In this article, we will teach you how to use our schedules in WitherHosting to run automated tasks and many other things!
First, make sure you've logged into https://witherpanel.com/ . Then, go to the server you want to manage schedules for. Click on the Schedules button.
Then, click on Create Schedule so you can create a new schedule, to run tasks under this schedule as you want.
A window will pop up with some information for you to fill in. Let's understand each field one by one.
Schedule Name - Specify the name of this schedule. It can be anything - Backups, Blah, Test, etc.
Minute - Specify at what minute, or at how many minutes you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th minute of the hour, so at 12:05, 1:05, 2:05, and so on. If you write "/5", it means that the schedule will run every 5 minutes, so at 12:05, 12:10, 12:15, and so on.
Hour - Specify at what hour, or at how many hours you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th hour of the day, so at 5:00 every day. If you write "/5", it means that the schedule will run every 5 hours, so at 12:00, 5:00, 10:00, and so on.
Day of the Month - Specify at what day of the month, or at how many days you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th of the month, so at 5th July. If you write "/5", it means that the schedule will run every 5 days, so at 5th, 10th, 15th, and so on.
Month - Specify at what month of the year, or at how many years you want the schedule to run. For example, if you write "5" in the field, the schedule will run every May. If you write "/5", it means that the schedule will run every 5 months, so at May, October, and so on.
Day of the Week - Specify at day of the week, or at how many weeks you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th day of the week, i.e., Friday.
A very helpful website on understanding cronjob syntax ( the system we use ) can be found on this website - https://crontab.guru/
Once you've set in your required fields, you also have the two options -
Show Cheatsheet - Whether or not to show the cron cheatsheet that explains how to use our system
Only when server is online - Whether or not to run this while the server is online, or as well as offline.
Schedule Enabled - Whether or not to instantly start this schedule, or choose to run it yourself manually afterwards.
Then, simply click on "Create Schedule". Once created, click on it, to proceed to add tasks.
Click on New Task. A window will appear which we will now explain in further detail.
In the window, you'll see -
Action - This can be used to specify what you want the server to do. It has the options Send Command, Send Power Actions, and Create Backup.
Send Command - If you want to execute any console commands, you can do so here. In the Payload field, specify the command which you want to run.
Send Power Action - If you want to schedule automatic restarts, or send any other power actions to the server, such as start, stop, restart, and kill.
Create Backup - If you want to create a backup, you can use this feature. You can also specify the ignored files and directories as well.
You have time offset, which can be used to determine after how long from the 1st task should this task be run. ( Note that time offset only makes sense when you have more than 2 tasks. )
You also have Continue on failure - If you want your tasks to continue regardless of it working or not, enable this. Then, click on Create Task.
Let's verify that this task actually works. I will click on the "Run Now" button to immediately execute this task.
And as you can see, the server successfully ran the command and it is working.
That's the guide on How to Use our Schedules! If you have any questions regarding the article, feel free to open a live chat, and we'll answer them as soon as we can! You can also join the discussion at our discord to get help from other members and staff!
⏳ Creating a Schedule ⏳
First, make sure you've logged into https://witherpanel.com/ . Then, go to the server you want to manage schedules for. Click on the Schedules button.
Then, click on Create Schedule so you can create a new schedule, to run tasks under this schedule as you want.
✅ Understanding the Schedules ✅
A window will pop up with some information for you to fill in. Let's understand each field one by one.
Schedule Name - Specify the name of this schedule. It can be anything - Backups, Blah, Test, etc.
Minute - Specify at what minute, or at how many minutes you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th minute of the hour, so at 12:05, 1:05, 2:05, and so on. If you write "/5", it means that the schedule will run every 5 minutes, so at 12:05, 12:10, 12:15, and so on.
Hour - Specify at what hour, or at how many hours you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th hour of the day, so at 5:00 every day. If you write "/5", it means that the schedule will run every 5 hours, so at 12:00, 5:00, 10:00, and so on.
Day of the Month - Specify at what day of the month, or at how many days you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th of the month, so at 5th July. If you write "/5", it means that the schedule will run every 5 days, so at 5th, 10th, 15th, and so on.
Month - Specify at what month of the year, or at how many years you want the schedule to run. For example, if you write "5" in the field, the schedule will run every May. If you write "/5", it means that the schedule will run every 5 months, so at May, October, and so on.
Day of the Week - Specify at day of the week, or at how many weeks you want the schedule to run. For example, if you write "5" in the field, the schedule will run every 5th day of the week, i.e., Friday.
A very helpful website on understanding cronjob syntax ( the system we use ) can be found on this website - https://crontab.guru/
Once you've set in your required fields, you also have the two options -
Show Cheatsheet - Whether or not to show the cron cheatsheet that explains how to use our system
Only when server is online - Whether or not to run this while the server is online, or as well as offline.
Schedule Enabled - Whether or not to instantly start this schedule, or choose to run it yourself manually afterwards.
Then, simply click on "Create Schedule". Once created, click on it, to proceed to add tasks.
➕ Adding Tasks ➕
Click on New Task. A window will appear which we will now explain in further detail.
In the window, you'll see -
Action - This can be used to specify what you want the server to do. It has the options Send Command, Send Power Actions, and Create Backup.
Send Command - If you want to execute any console commands, you can do so here. In the Payload field, specify the command which you want to run.
Send Power Action - If you want to schedule automatic restarts, or send any other power actions to the server, such as start, stop, restart, and kill.
Create Backup - If you want to create a backup, you can use this feature. You can also specify the ignored files and directories as well.
You have time offset, which can be used to determine after how long from the 1st task should this task be run. ( Note that time offset only makes sense when you have more than 2 tasks. )
You also have Continue on failure - If you want your tasks to continue regardless of it working or not, enable this. Then, click on Create Task.
✔️ Verifying the schedule is working ✔️
Let's verify that this task actually works. I will click on the "Run Now" button to immediately execute this task.
And as you can see, the server successfully ran the command and it is working.
That's the guide on How to Use our Schedules! If you have any questions regarding the article, feel free to open a live chat, and we'll answer them as soon as we can! You can also join the discussion at our discord to get help from other members and staff!
Updated on: 23/11/2023
Thank you!