Install/3-4/Cron - Revision history

Alofoxx at 00:23, 7 October 2023

2023-10-07T00:23:39Z

← Older revision		Revision as of 19:23, 6 October 2023
Line 1:		Line 1:
	<div style="float:right;">		<div style="float:right;">
	[[Install/3-0/~~CMApp~~\|Next: 3.0 - ~~Installing Convention Master~~ >>]]		[[Install/3-5/CUPS\|Next: 3.5 - Install the CUPS Printing System >>]]
	</div>		</div>
	[[Install/2-4/~~Ioncube~~\|<< Previously: 2.4 - ~~Install~~ the ~~Ioncube Loader~~]]		[[Install/3-3/CMConfig\|<< Previously: 3.3 - Connect Convention Master to the Database]]

Alofoxx: Alofoxx moved page Install/2-5/Cron to Install/3-4/Cron without leaving a redirect

2023-10-07T00:17:28Z

Alofoxx moved page Install/2-5/Cron to Install/3-4/Cron without leaving a redirect

← Older revision	Revision as of 19:17, 6 October 2023
(No difference)

Aloha: /* Manual Setup for Cron Jobs */

2020-02-24T22:15:49Z

Manual Setup for Cron Jobs

← Older revision		Revision as of 17:15, 24 February 2020
Line 27:		Line 27:
	and the script will install it for you.		and the script will install it for you.

	== Manual Setup for ~~Cron Jobs~~ ==		== Manual Cron Job Setup for CM ==

	=== Set up Cron Job for CM ===		=== Set up Cron Job for CM ===

Aloha at 22:15, 24 February 2020

2020-02-24T22:15:10Z

@@ Line 11: / Line 11: @@
 * See [[Automated Tasks]]
-== Set up Cron Job for CM ==
+== Automated Cron Job setup for CM ==
 In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's scheduler. On Linux, this system is generally Cron, but on your system it may be called something else. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.

Silvershock at 01:13, 5 June 2019

2019-06-05T01:13:13Z

← Older revision		Revision as of 20:13, 4 June 2019
Line 2:		Line 2:
	[[Install/3-0/CMApp\|Next: 3.0 - Installing Convention Master >>]]		[[Install/3-0/CMApp\|Next: 3.0 - Installing Convention Master >>]]
	</div>		</div>
	[[Install/2-4/Ioncube\|<< Previously: 2.3 - ~~Configure Apache Webserver~~]]		[[Install/2-4/Ioncube\|<< Previously: 2.4 - Install the Ioncube Loader]]

Silvershock at 01:12, 5 June 2019

2019-06-05T01:12:52Z

← Older revision		Revision as of 20:12, 4 June 2019
Line 1:		Line 1:
	=== ~~Cron Jobs and CM ===~~		<div style="float:right;">
			[[Install/3-0/CMApp\|Next: 3.0 - Installing Convention Master >>]]
			</div>
			[[Install/2-4/Ioncube\|<< Previously: 2.3 - Configure Apache Webserver]]


			= Set Up Scheduled Tasks =

	CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not require that a user have a tab open in their browser to run.		CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not require that a user have a tab open in their browser to run.
	Currently, CM has five scheduled tasks that are run by this script:		Currently, CM has five scheduled tasks that are run by this script:
	* See [[Automated Tasks]]		* See [[Automated Tasks]]

	=== Set up Cron Job for CM ===		== Set up Cron Job for CM ==
	In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's Cron. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.
			In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's scheduler. On Linux, this system is generally Cron, but on your system it may be called something else. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.

	'''NOTE: If we are hosting your installation simply contact support and we will get it setup for you when needed.'''		'''NOTE: If we are hosting your installation simply contact support and we will get it setup for you when needed.'''

	These instructions assume:		These instructions assume:

	# You have shell access to your web server running Convention Master and <code>sudo</code> privileges. If you don't have either of these and would like help setting this up, please contact our support.		# You have shell access to your web server running Convention Master and <code>sudo</code> privileges. If you don't have either of these and would like help setting this up, please contact our support.
	# Your server ~~apache~~ user is <code>www-data</code> (default on ~~ubuntu~~) - if ~~its not~~, substitute your ~~apache~~ user in "Create entry in Cron".		# Your server Apache user is <code>www-data</code> (the default on Ubuntu) - if it is something else, substitute your Apache user in "Create entry in Cron".
	~~# Your server has the package "run-one" installed. (This comes pre-installed on ubuntu.)~~
	::: You can check by running <code>dpkg -l run-one</code> in your terminal. This will make sure the script is only ever running one copy at a time and will block any copies from running until the first one is done.

	==~~== Get You Needed~~ Information ====		== Fetch Required Information ==

	Before you can set up a new Cron task for cm, you should note down where your CM is installed. This is the folder that you downloaded the CM code into.		Before you can set up a new Cron task for cm, you should note down where your CM is installed. This is the folder that you downloaded the CM code into.
	~~Our install~~ guide ~~has you place~~ it in <code> /var/www/</code>. ~~We will assume this is the location for the rest of the instructions, if~~ your location is different substitute <code> /var/www/ </code> with your path.		As with the rest of this guide, we will assume it is located in <code> /var/www/</code>. If your location is different, substitute <code> /var/www/ </code> with your path.

	Inside this folder you should have <code>automated_tasks/cm_task_manager.php</code>.		Inside this folder you should have <code>automated_tasks/cm_task_manager.php</code>.
Line 24:		Line 31:
	This means that the full path of the CM cron script is <code> /var/www/automated_tasks/cm_task_manager.php </code>. '''Note this as your script path.'''		This means that the full path of the CM cron script is <code> /var/www/automated_tasks/cm_task_manager.php </code>. '''Note this as your script path.'''

	Next, you need to ~~get where php is installed~~. Type <code>which php</code> into your terminal to get this information.		Next, you will need the full path to your PHP executable. Type <code>which php</code> into your terminal to get this information.
	It should output something like <code>/usr/bin/php</code>. '''Note this as your php path.'''		It should output something like <code>/usr/bin/php</code>. '''Note this as your php path.'''

Line 30:		Line 37:
	We recommend every 5 minutes which will look like this <code>/5 * * *</code>. '''Note this as your cron timing.'''		We recommend every 5 minutes which will look like this <code>/5 * * *</code>. '''Note this as your cron timing.'''

	==== Create entry in Cron ====		== Create entry in Cron ==

	Now you have what you need to create the Cron entry.		Now you have what you need to create the Cron entry.
	# Type <code> sudo crontab -u www-data -e</code> to open the Cron file for ~~root~~ user.		# Type <code> sudo crontab -u www-data -e</code> to open the Cron scheduling file (the crontab) for the web user.
	# Move to the bottom of the file and add a new line.		# Move to the bottom of the file and add a new line.
	# Enter your cron timing~~, "run-one"~~, php path, and script path as noted. Your line should look like this: <code>/5 * * * ~~run-one~~ /usr/bin/php /var/www/automated_tasks/cm_task_manager.php</code>		# Enter your cron timing, php path, and script path as noted. Your line should look like this: <code>/5 * * * /usr/bin/php /var/www/automated_tasks/cm_task_manager.php</code>
	# Make another blank line after your entry and save the file.		# Make another blank line after your entry and save the file.

	~~Thats it~~.		Setup is now complete.

Silvershock: Silvershock moved page Cron Jobs to Install/2-5/Cron: Cron setup should be part of the installation process

2019-06-05T00:59:09Z

Silvershock moved page Cron Jobs to Install/2-5/Cron: Cron setup should be part of the installation process

← Older revision	Revision as of 19:59, 4 June 2019
(No difference)

Alofoxx: Created page with "=== Cron Jobs and CM === CM uses a script (`cm_task_manager.php`)to run scheduled tasks on the server backend so that it can have more time to do its job, and not r..."

2018-11-23T09:08:11Z

Created page with "=== Cron Jobs and CM === CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not r..."

New page

=== Cron Jobs and CM ===
CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not require that a user have a tab open in their browser to run.
Currently, CM has five scheduled tasks that are run by this script:
* See [[Automated Tasks]]

=== Set up Cron Job for CM ===
In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's Cron. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.

'''NOTE: If we are hosting your installation simply contact support and we will get it setup for you when needed.'''

These instructions assume:
# You have shell access to your web server running Convention Master and <code>sudo</code> privileges. If you don't have either of these and would like help setting this up, please contact our support.
# Your server apache user is <code>www-data</code> (default on ubuntu) - if its not, substitute your apache user in "Create entry in Cron".
# Your server has the package "run-one" installed. (This comes pre-installed on ubuntu.)
::: You can check by running <code>dpkg -l run-one</code> in your terminal. This will make sure the script is only ever running one copy at a time and will block any copies from running until the first one is done.

==== Get You Needed Information ====

Before you can set up a new Cron task for cm, you should note down where your CM is installed. This is the folder that you downloaded the CM code into.
Our install guide has you place it in <code> /var/www/</code>. We will assume this is the location for the rest of the instructions, if your location is different substitute <code> /var/www/ </code> with your path.

Inside this folder you should have <code>automated_tasks/cm_task_manager.php</code>.

This means that the full path of the CM cron script is <code> /var/www/automated_tasks/cm_task_manager.php </code>. '''Note this as your script path.'''

Next, you need to get where php is installed. Type <code>which php</code> into your terminal to get this information.
It should output something like <code>/usr/bin/php</code>. '''Note this as your php path.'''

Last, determine how often you want it to check if there is anything to do. To make up your own you can look at [http://www.crontabgenerator.com/ crontabgenerator]
We recommend every 5 minutes which will look like this <code>*/5 * * * *</code>. '''Note this as your cron timing.'''

==== Create entry in Cron ====

Now you have what you need to create the Cron entry.
# Type <code> sudo crontab -u www-data -e</code> to open the Cron file for root user.
# Move to the bottom of the file and add a new line.
# Enter your cron timing, "run-one", php path, and script path as noted. Your line should look like this: <code>*/5 * * * * run-one /usr/bin/php /var/www/automated_tasks/cm_task_manager.php</code>
# Make another blank line after your entry and save the file.

Thats it.