You are here

INSTALL.txt in Elysia Cron 5

UPGRADE A NEW VERSION
----------------------

If you are upgrading from an old version of elysia_cron you should simply 
replace module files. You don't even need to execute the "update.php" drupal
process: Elysia cron will detect the new version on its first run and updates
itself automatically.


INSTALLATION 
-------------

For the basic install you only need to enable the module and Elysia Cron will be
up and running.

You can stop here if you don't need a great precision over task execution and
you don't have to execute a task more often than once an hour.  
For example, if you need only the "Once a day", "Once a week" or "Once a month" 
schedule rules the basic install is fine. (For D6 users that want to stop here: 
you should have installed Drupal crontab as described in Drupal INSTALL guide).

Instead, if you need:
- to run some tasks more often than once an hour (eg: you have a function that
  should be executed every 5 minutes)
- to execute a task at an exact time (eg:you must run a function at exactly 
  "17:23") 
... you must follow Step B


STEP B: CHANGE SYSTEM CRONTAB (OPTIONAL)
-----------------------------------------

To get the full potential out of elysia cron and have the full control over you
tasks a further step is needed: you need to configure the system crontab to
execute drupal cron every minute.

To do this refer to the section "Configuring cron jobs" of drupal documentation:
http://drupal.org/cron

The only difference is that you should use the "* * * * *" rule part instead of
"0 * * * *" or "45 * * * *" as described in the guide.

While you're editing the system crontab, it's also recommended to replace the
"/cron.php" part with "/sites/modules/elysia_cron/cron.php" (if you have
installed elysia_cron in "sites/modules" directory).
This is an optional step (you can leave "/cron.php" if you want), doing it will 
result in a better performance in bigger sites (elysia_cron's cron.php handles 
cache in a better way).

For example: 
* * * * * wget -O - -q -t 1 http://www.example.com/sites/all/modules/elysia_cron/cron.php

IF YOU WANT TO ENABLE CRON KEY SECURITY...

... you should also add the choosen cron key (from elysia_cron setup) to the
call.

Example: 
* * * * * wget -O - -q -t 1 http://www.example.com/sites/all/modules/elysia_cron/cron.php?cron_key=12345678

That's all, now you can go the the cron administration page to configure your
tasks.
(NOTE: In D7, having a system crontab defined, you can set the "Run cron on 
visitor's requests, every" setting to "Never")

By default elysia_cron will run all standard cron jobs sequentially (in a
single channel) once an hour. You can change this behavious with elysia_cron
setup.

To access elysia_cron setup, and change the scheduling of your jobs or view
execution stats, go to cron page from administration menu.

Note: to better see warnings on administration page you should consider adding
a rule for "warn" class to theme CSS stylesheet, like this one: .warn { color:
red; font-weight: bold; }


PERMISSIONS
------------

You can also give 'administer elysia_cron' permission to all user roles that
needs to administer cron jobs. You can do this with standard drupal users
administration.

File

INSTALL.txt
View source
  1. UPGRADE A NEW VERSION
  2. ----------------------
  3. If you are upgrading from an old version of elysia_cron you should simply
  4. replace module files. You don't even need to execute the "update.php" drupal
  5. process: Elysia cron will detect the new version on its first run and updates
  6. itself automatically.
  7. INSTALLATION
  8. -------------
  9. For the basic install you only need to enable the module and Elysia Cron will be
  10. up and running.
  11. You can stop here if you don't need a great precision over task execution and
  12. you don't have to execute a task more often than once an hour.
  13. For example, if you need only the "Once a day", "Once a week" or "Once a month"
  14. schedule rules the basic install is fine. (For D6 users that want to stop here:
  15. you should have installed Drupal crontab as described in Drupal INSTALL guide).
  16. Instead, if you need:
  17. - to run some tasks more often than once an hour (eg: you have a function that
  18. should be executed every 5 minutes)
  19. - to execute a task at an exact time (eg:you must run a function at exactly
  20. "17:23")
  21. ... you must follow Step B
  22. STEP B: CHANGE SYSTEM CRONTAB (OPTIONAL)
  23. -----------------------------------------
  24. To get the full potential out of elysia cron and have the full control over you
  25. tasks a further step is needed: you need to configure the system crontab to
  26. execute drupal cron every minute.
  27. To do this refer to the section "Configuring cron jobs" of drupal documentation:
  28. http://drupal.org/cron
  29. The only difference is that you should use the "* * * * *" rule part instead of
  30. "0 * * * *" or "45 * * * *" as described in the guide.
  31. While you're editing the system crontab, it's also recommended to replace the
  32. "/cron.php" part with "/sites/modules/elysia_cron/cron.php" (if you have
  33. installed elysia_cron in "sites/modules" directory).
  34. This is an optional step (you can leave "/cron.php" if you want), doing it will
  35. result in a better performance in bigger sites (elysia_cron's cron.php handles
  36. cache in a better way).
  37. For example:
  38. * * * * * wget -O - -q -t 1 http://www.example.com/sites/all/modules/elysia_cron/cron.php
  39. IF YOU WANT TO ENABLE CRON KEY SECURITY...
  40. ... you should also add the choosen cron key (from elysia_cron setup) to the
  41. call.
  42. Example:
  43. * * * * * wget -O - -q -t 1 http://www.example.com/sites/all/modules/elysia_cron/cron.php?cron_key=12345678
  44. That's all, now you can go the the cron administration page to configure your
  45. tasks.
  46. (NOTE: In D7, having a system crontab defined, you can set the "Run cron on
  47. visitor's requests, every" setting to "Never")
  48. By default elysia_cron will run all standard cron jobs sequentially (in a
  49. single channel) once an hour. You can change this behavious with elysia_cron
  50. setup.
  51. To access elysia_cron setup, and change the scheduling of your jobs or view
  52. execution stats, go to cron page from administration menu.
  53. Note: to better see warnings on administration page you should consider adding
  54. a rule for "warn" class to theme CSS stylesheet, like this one: .warn { color:
  55. red; font-weight: bold; }
  56. PERMISSIONS
  57. ------------
  58. You can also give 'administer elysia_cron' permission to all user roles that
  59. needs to administer cron jobs. You can do this with standard drupal users
  60. administration.