modules/cronplus/INSTALL.txt

$Id: INSTALL.txt,v 1.2 2005/06/03 14:10:11 syscrusher Exp $


              INSTALLATION INSTRUCTIONS

To install and use this module:

0. Read the README.txt and INSTALL.txt files thoroughly.

1. Copy the Cronplus files to an appropriate subdirectory in your Drupal
   environment (such as "modules/cronplus").

   This module does not require any module-specific database tables.

2. Enable the Cronplus module using the Drupal administrative screen.

3. Use the settings page to configure Cronplus as you wish. Current
   options include:

   * Preferred hour

     For cronplus runs that happen at daily, or longer, time intervals,
     this option instructs the module to do its work at the first Drupal
     cron run that happens during or after the specified hour (24-hour
     time, GMT timezone).

   * Preferred weekday

     For cronplus runs that happen at weekly, or longer, time intervals,
     this option instructs the module to do its work at the first Drupal
     cron run that happens during or after the specified day of the week.
     Note that the "preferred hour" option is still in effect also, so
     the two together attempt to set the weekday and the hour of the day.

   Note that *both* of these options are only advisory to cronplus.module.
   Its ability to follow these instructions depends on how often your
   Drupal system invokes cron.php. In general, the more frequently cron.php
   is invoked, the closer to your requested day of week and hour of day
   the jobs will actually run. cronplus.module will forego the preferred
   day and hour settings if it detects that a given run is overdue. The
   priority is to get the runs to happen at or near the appropriate
   intervals first and foremost. Over time, a well-tuned system should
   (in theory) tend to converge toward your preferred values.

4. TROUBLESHOOTING

   If you have problems with cron.php timing out, check your PHP settings
   for maximum script execution time, and also check the timeout setting
   for the system batch job that invokes cron.php. (In Linux systems,
   this would typically be either "wget" or "curl" commands, both of
   which have options to set the time limit.)

   Note that under certain circumstances -- particularly, when the module
   is first installed -- it is *NORMAL* for the time interval hooks to
   be invoked twice in fairly rapid succession. This will self-correct as
   the previous run history is written into the {variable} table.
1	$Id: INSTALL.txt,v 1.2 2005/06/03 14:10:11 syscrusher Exp $
2
3
4	INSTALLATION INSTRUCTIONS
5
6	To install and use this module:
7
8	0. Read the README.txt and INSTALL.txt files thoroughly.
9
10	1. Copy the Cronplus files to an appropriate subdirectory in your Drupal
11	environment (such as "modules/cronplus").
12
13	This module does not require any module-specific database tables.
14
15	2. Enable the Cronplus module using the Drupal administrative screen.
16
17	3. Use the settings page to configure Cronplus as you wish. Current
18	options include:
19
20	* Preferred hour
21
22	For cronplus runs that happen at daily, or longer, time intervals,
23	this option instructs the module to do its work at the first Drupal
24	cron run that happens during or after the specified hour (24-hour
25	time, GMT timezone).
26
27	* Preferred weekday
28
29	For cronplus runs that happen at weekly, or longer, time intervals,
30	this option instructs the module to do its work at the first Drupal
31	cron run that happens during or after the specified day of the week.
32	Note that the "preferred hour" option is still in effect also, so
33	the two together attempt to set the weekday and the hour of the day.
34
35	Note that both of these options are only advisory to cronplus.module.
36	Its ability to follow these instructions depends on how often your
37	Drupal system invokes cron.php. In general, the more frequently cron.php
38	is invoked, the closer to your requested day of week and hour of day
39	the jobs will actually run. cronplus.module will forego the preferred
40	day and hour settings if it detects that a given run is overdue. The
41	priority is to get the runs to happen at or near the appropriate
42	intervals first and foremost. Over time, a well-tuned system should
43	(in theory) tend to converge toward your preferred values.
44
45	4. TROUBLESHOOTING
46
47	If you have problems with cron.php timing out, check your PHP settings
48	for maximum script execution time, and also check the timeout setting
49	for the system batch job that invokes cron.php. (In Linux systems,
50	this would typically be either "wget" or "curl" commands, both of
51	which have options to set the time limit.)
52
53	Note that under certain circumstances -- particularly, when the module
54	is first installed -- it is NORMAL for the time interval hooks to
55	be invoked twice in fairly rapid succession. This will self-correct as
56	the previous run history is written into the {variable} table.