docs/documentation/admin/cron_setup.php

   1 <?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate$'; ?>
   2
   3 <h2>Cron Set-Up</h2>
   4
   5         <p>ATutor operates best with the help of an automated event scheduler, commonly known as a <em>cron job</em>. The cron interval should be set at between 5-30 minutes, depending on server resources. Setting the cron to 10-15 minutes is recommended.</p>
   6
   7         <p>The cron is run by requesting a specific ATutor page, and can be initiated by any machine that has an Internet connection and access to the ATutor installation.</p>
   8
   9         <p>Notice that the URL being used will be unique for each installation and that for security reasons the requested URL includes a secret six-character alpha-numerica authentication key. The cron will not run if the key is incorrect or missing.</p>
  10
  11         <p>The <em><a href="system_preferences.php">Mail Queue</a></em> feature requires the cron to be set-up and running correctly before it can be enabled.</p>
  12
  13         <h3>Unix Setup</h3>
  14                 <ol>
  15                         <li>Enter your hosts cron utility, either using an existing web interface or from the shell with the command <code>crontab -e</code>.</li>
  16                         <li>To run the cron every 10 minutes enter one of the following lines into the crontab editor:<br />
  17                           <code>*/10 * * * * wget -q -O /dev/null http://<em>your-server.com/atutor/</em>admin/cron.php?k=<em>SECRET-KEY</em></code><br />
  18                           Or<br />
  19                           <code>*/10 * * * * lynx -dump http://<em>your-server.com/atutor/</em>admin/cron.php?k=<em>SECRET-KEY</em> > /dev/null</code>
  20                           <p>Replace <em><code>your-server.com/atutor/</code></em> with the full server and path to your ATutor installation.</p>
  21                           <p>Replace <em><code>SECRET-KEY</code></em> with the key provided on the Cron Configuration page in your ATutor Administration section.</p>
  22                           <p>Replace <code>10</em> with the desired interval.</p>
  23                           </li>
  24                 </ol>
  25
  26                 <p>Note: If your site uses <acronym title="Secure Sockets Layer">SSL</acronym> then replace <em>http</em> with <em>https</em> and you may also need to add <code>--no-check-certificate</code> to <code>wget</code>.</p>
  27
  28         <h3>Windows et al Setup</h3>
  29                 <p><a href="http://www.webcron.org">webcron.org</a> offers free web-based cron services and is available in multiple languages.</p>
  30
  31
  32 <?php require('../common/body_footer.inc.php'); ?>