documentation/admin/requirements_recommendations.php

   1 <?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate$'; ?>
   2
   3 <h2>Requirements &amp; Recommendations</h2>
   4         <p>The first step when installing or upgrading ATutor is to check if the minimum requirements are met. The following describes those checks.</p>
   5
   6         <h3>File Integrity</h3>
   7                 <p>The Case Sensitivity check verifies that file names were not converted to lower-case during the extraction process. This is not an issue on case-insensitive operating systems like MS Windows, but is an issue on case-sensative ones like Linux.</p>
   8
   9         <h3>Web Server</h3>
  10                 <p>The ATutor development and testing processes are done primarily on Apache 1.3 and Apache 2 (using pre-forking), and as such we strongly recommend them for production environments. ATutor has been successfully installed on other web servers, including, Zeus, lighttpd, Abyss, Zazou Mini Web Server, Microsoft IIS, and Jana-Server.</p>
  11
  12                 <p>The web server can be configured with <acronym title="Secure Sockets Layer">SSL</acronym> for added security or to use a non-standard port and ATutor will function without modification.</p>
  13
  14
  15         <h3>PHP</h3>
  16                 <p>ATutor is written in the <acronym title="Recursive acronym for PHP: Hypertext Preprocessor">PHP</acronym> language. The PHP configuration file contains many configuration settings that can be changed. The following are the minimum requirements needed to install and use ATutor.</p>
  17
  18                 <dl>
  19                         <dt>PHP 4.3.0+</dt>
  20                         <dd>PHP 4.3.0 or higher is required. Version 5.2.0 or higher is recommended.</dd>
  21
  22                         <dt><kbd>zlib</kbd></dt>
  23                         <dd>Zlib support must be enabled in PHP; It is used for compressing and uncompressing ZIP files.</dd>
  24
  25                         <dt><kbd>mysql</kbd></dt>
  26                         <dd>MySQL support must be enabled in PHP.</dd>
  27
  28                         <dt><kbd>safe_mode = Off</kbd></dt>
  29                         <dd><kbd>safe_mode</kbd> must be disabled in PHP. ATutor cannot function with the restrictions enforced when <kbd>safe_mode</kbd> is enabled.</dd>
  30
  31                         <dt><kbd>file_uploads = On</kbd></dt>
  32                         <dd>File uploads support must be enabled in PHP.</dd>
  33
  34                         <dt><kbd>upload_max_filesize</kbd> >= 2 MB</dt>
  35                         <dd>This option specifies the maximum size of files that can be uploaded to ATutor.</dd>
  36
  37                         <dt><kbd>post_max_size</kbd> >= 8 MB</dt>
  38                         <dd>This value must be larger than the <kbd>upload_max_filesize</kbd>.</dd>
  39
  40                         <dt><kbd>sessions</kbd></dt>
  41                         <dd>Sessions support must be enabled in PHP.</dd>
  42
  43                         <dt><kbd>session.auto_start = 0</kbd></dt>
  44                         <dd><kbd>session.auto_start</kbd> must be disabled in PHP.</dd>
  45
  46                         <dt><kbd>session.save_path</kbd></dt>
  47                         <dd><kbd>session.save_path</kbd> must be set to a real path that can store session data.</dd>
  48
  49                         <dt><kbd>.</kbd> in <kbd>include_path</kbd></dt>
  50                         <dd><kbd>.</kbd> must be in the list of paths in the <kbd>include_path</kbd> option.</dd>
  51                 </dl>
  52
  53
  54                 <p>Additionally, the following <kbd>php.ini</kbd> configuration settings are recommended:</p>
  55                 <pre>display_errors          = Off
  56 arg_separator.input     = ";&amp;"
  57 register_globals        = Off
  58 magic_quotes_gpc        = Off
  59 magic_quotes_runtime    = Off
  60 allow_url_fopen         = On
  61 allow_url_include       = Off
  62 register_argc_argv      = Off
  63 zlib.output_compression = On
  64 session.use_trans_sid   = 0
  65 </pre>
  66
  67         <h3>MySQL</h3>
  68                 <p>Currently ATutor only supports the MySQL database. MySQL 4.0.2 or higher, or 4.1.10 or higher is required. MySQL 4.0.20 and higher or 4.1.10 and higher is recommended, especially if you are using languages that would benefit from being represented in the <acronym title="UCS Transformation Format, a multibyte character encoding format.">UTF-8</acronym> character set. As ATutor moves towards utilizing UTF-8 throughout, support for older version of MySQL will be removed.</p>
  69
  70                 <p>A database user account with database creation privileges is required if your database does not already exist. That same user will then need table creation privileges for the chosen database. See the MySQL chapter <a href="http://dev.mysql.com/doc/mysql/en/privileges.html" target="_new">How the Privilege System Works</a> for additional information.</p>
  71
  72         <h3>Web Browser</h3>
  73                 <p>ATutor makes use of many new HTML features that are only supported in recent web browsers. Though ATutor is designed to function effectively in older browsers we strongly recommend using the latest version of your favorite browser. We recommend <a href="http://getfirefox.com" target="_new">FireFox</a> for either Windows, *nix or Mac OS X.</p>
  74
  75 <?php require('../common/body_footer.inc.php'); ?>