TWiki/TWikiSystemRequirements.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#TWiki System Requirements"> TWiki System Requirements</a><ul>
   4         <li><a href="#Server Requirements"> Server Requirements</a></li>
   5         <li><a href="#Client Requirements"> Client Requirements</a></li>
   6         <li><a href="#Known Issues"> Known Issues</a></li>
   7       </ul>
   8     </li>
   9   </ul>
  10 </div>
  11
  12 # <a name="TWiki System Requirements"></a> TWiki System Requirements
  13
  14 _Server and client requirements for TWiki 01-Feb-2003_
  15
  16 Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.
  17
  18 ## <a name="Server Requirements"></a> Server Requirements
  19
  20 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.
  21
  22 <table border="1" cellpadding="0" cellspacing="0">
  23   <tr>
  24     <th bgcolor="#99CCCC"><strong> Resource </strong></th>
  25     <th bgcolor="#99CCCC"><strong> Required Server Environment * </strong></th>
  26   </tr>
  27   <tr>
  28     <td> Perl </td>
  29     <td> 5.005_03 or higher (5.6.1 recommended, 5.8.0 <strong>not</strong> recommended yet, see TWiki:Codev.IssuesWithPerl5dot8) </td>
  30   </tr>
  31   <tr>
  32     <td> Non-standard Perl modules </td>
  33     <td> %BULLET% Unix: <code>Net::SMTP</code> (or <code>sendmail</code>) %BB% Windows: <code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
  34   </tr>
  35   <tr>
  36     <td> RCS </td>
  37     <td> 5.7 or higher (including GNU <code>diff</code>) %BR% Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite </td>
  38   </tr>
  39   <tr>
  40     <td> GNU <code>diff</code></td>
  41     <td> GNU <code>diff</code> 2.7 or higher is required when not using the all-Perl RcsLite. %BR% Install on PATH if not included with RCS (check version with <code>diff -v</code>) %BR% Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to <code>diff</code></td>
  42   </tr>
  43   <tr>
  44     <td> Other external programs </td>
  45     <td><code>fgrep, egrep</code></td>
  46   </tr>
  47   <tr>
  48     <td> Cron/scheduler </td>
  49     <td> %BULLET% Unix: <code>cron</code> %BB% Windows: <code>cron</code> equivalents </td>
  50   </tr>
  51   <tr>
  52     <td> Web server </td>
  53     <td> Apache 1.3 is well supported; Apache 2.0 is <strong>not</strong> recommended yet (see TWiki:Codev.IssuesWithApache2dot0). %BR% For other servers, CGI support, authentication, extended path info required; also, the <code>register</code> script is likely to need significant changes </td>
  54   </tr>
  55 </table>
  56
  57 %X% **\*** _Current documentation mainly covers Linux and Apache installations. See [[WindowsInstallCookbook]] for a Windows installation guide. See TWiki:Codev.TWikiOn for help with installation on various platforms including Unix, MacOS X, Apache `mod_perl`, web hosts, etc._
  58
  59 <a name="ClientRequirements"></a>
  60
  61 ## <a name="Client Requirements"></a> Client Requirements
  62
  63 The TWiki [[standard installation|Main/TWikiInstallationGuide]] has extremely low browser requirements:
  64
  65 - HTML 3.2 compliant
  66 - generates XHTML 1.0 pages that are compatible with HTML 3.2
  67 - minimal use of JavaScript in the user interface (degrades gracefully)
  68 - no cookies
  69 - no CSS
  70
  71 You can easily add functionality, by customizing [[TWikiTemplates]], for one, while tailoring the browser requirements to your situation.
  72
  73 ## <a name="Known Issues"></a> Known Issues
  74
  75 - The [[TWikiPlugins]] feature currently does not have compatibility guidelines for developers. Plugins can require just about anything - browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
  76   - %H% Plugins included in the TWiki distribution do not add requirements.
  77
  78 -- TWiki:Main.MikeMannix - 12 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 16 Dec 2003