TWiki/TWikiSystemRequirements.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#TWiki System Requirements"> TWiki System Requirements</a><ul>
   4         <li><a href="#Overview"> Overview</a></li>
   5         <li><a href="#Server Requirements"> Server Requirements</a></li>
   6         <li><a href="#Client Requirements"> Client Requirements</a></li>
   7         <li><a href="#Known Issues"> Known Issues</a></li>
   8       </ul>
   9     </li>
  10   </ul>
  11 </div>
  12
  13 # <a name="TWiki System Requirements"></a> TWiki System Requirements
  14
  15 _Server and client system requirements for TWiki 01-Sep-2001_
  16
  17 ## <a name="Overview"></a> Overview
  18
  19 Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.
  20
  21 ## <a name="Server Requirements"></a> Server Requirements
  22
  23 TWiki is written in Perl 5, uses a number of shell commands, and requires [RCS (Revision Control System)](http://www.gnu.org/software/rcs/rcs.html), a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements:
  24
  25 <table border="1" cellpadding="0" cellspacing="0">
  26   <tr>
  27     <th bgcolor="#99CCCC" colspan="3"><strong> Required Server Environment </strong></th>
  28   </tr>
  29   <tr>
  30     <th bgcolor="#99CCCC"><strong> Resource </strong></th>
  31     <th bgcolor="#99CCCC"><strong> Unix </strong></th>
  32     <th bgcolor="#99CCCC"><strong> Windows </strong></th>
  33   </tr>
  34   <tr>
  35     <td> Perl </td>
  36     <td align="center" colspan="2"> 5.005_03 or higher </td>
  37   </tr>
  38   <tr>
  39     <td> Non standard Perl modules </td>
  40     <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
  41     <td align="center"><code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
  42   </tr>
  43   <tr>
  44     <td> RCS </td>
  45     <td align="center" colspan="2"> 5.7 or higher </td>
  46   </tr>
  47   <tr>
  48     <td> Other external programs </td>
  49     <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
  50   </tr>
  51   <tr>
  52     <td> Web server </td>
  53     <td align="center" colspan="2"> Apache; others (with support for CGI, authentication, extended path) <strong>*</strong></td>
  54   </tr>
  55 </table>
  56
  57 Current documentation covers Linux only. A [TWikiOnWindows](http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows) installation guide is next.
  58
  59 ## <a name="Client Requirements"></a> Client Requirements
  60
  61 The TWiki [[standard installation|Main/TWikiInstallationGuide]] has extremely low browser requirements:
  62
  63 - HTML 3.2 compliant
  64 - generates XHTML 1.0 pages that are compatible with HTML 3.2
  65 - minimal use of JavaScript in the user interface (degrades gracefully)
  66 - no cookies
  67 - no CSS
  68
  69 You can easily add capabilities, through customizing the templates, for one, while tailoring the browser requirements to your situation.
  70
  71 ## <a name="Known Issues"></a> Known Issues
  72
  73 - The new [[TWikiPlugins]] feature currently does not have compatibility guidelines for developers. Plugins can require just about anything: browser-specific functions, stylesheets (CSS), DHTML, Java applets, cookies.
  74
  75 -- [[MikeMannix]] - 15 Sep 2001 <br />