none
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
index 29c1482..b559741 100644 (file)
@@ -1,9 +1,8 @@
 <div>
   <ul>
     <li><a href="#TWiki System Requirements"> TWiki System Requirements</a><ul>
-        <li><a href="#Overview"> Overview</a></li>
-        <li><a href="#Server-Side Requirements"> Server-Side Requirements</a></li>
-        <li><a href="#Client-Side Requirements"> Client-Side Requirements</a></li>
+        <li><a href="#Server Requirements"> Server Requirements</a></li>
+        <li><a href="#Client Requirements"> Client Requirements</a></li>
         <li><a href="#Known Issues"> Known Issues</a></li>
       </ul>
     </li>
 
 # <a name="TWiki System Requirements"></a> TWiki System Requirements
 
-_Server and client system requirements of TWiki 01-Sep-2001_
+_Server and client requirements for TWiki 01-Feb-2003_
 
-## <a name="Overview"></a> Overview
+Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.
 
-Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.
+## <a name="Server Requirements"></a> Server Requirements
 
-## <a name="Server-Side Requirements"></a> Server-Side Requirements
-
-TWiki is written in Perl 5 and uses a number of shell commands. It requires GNU RCS (Revision Control System) to be installed on the same system. TWiki is developed in a standard Linux/Apache environment. It can also work with Microsoft Windows and other platforms.
+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.
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
@@ -29,46 +26,59 @@ TWiki is written in Perl 5 and uses a number of shell commands. It requires GNU
   <tr>
     <th bgcolor="#99CCCC"><strong> Resource </strong></th>
     <th bgcolor="#99CCCC"><strong> Unix </strong></th>
-    <th bgcolor="#99CCCC"><strong> Windows </strong></th>
+    <th bgcolor="#99CCCC"><strong> Windows* </strong></th>
   </tr>
   <tr>
     <td> Perl </td>
-    <td align="center" colspan="2"> 5.005_03 or higher </td>
+    <td align="center" colspan="2"> 5.005_03 or higher (5.6.1 recommended, <br /> 5.8.0 <strong>not</strong> recommended yet, see TWiki:Codev.UsingPerl58OnRedHat8) </td>
   </tr>
   <tr>
-    <td> Non standard Perl modules </td>
+    <td> Non-standard Perl modules </td>
     <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
-    <td align="right"><code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
+    <td align="center"><code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
   </tr>
   <tr>
     <td> RCS </td>
-    <td align="center" colspan="2"> 5.7 or higher </td>
+    <td align="center" colspan="2"> 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>
+  </tr>
+  <tr>
+    <td> GNU <code>diff</code></td>
+    <td align="center" colspan="2"> 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>) </td>
   </tr>
   <tr>
     <td> Other external programs </td>
     <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
   </tr>
   <tr>
+    <td> Cron/scheduler </td>
+    <td align="center"><code>cron</code></td>
+    <td><code>cron</code> equivalents </td>
+  </tr>
+  <tr>
     <td> Web server </td>
-    <td align="center" colspan="2"> Apache; others (with support for CGI, authentication, extended path) <strong>*</strong></td>
+    <td align="center" colspan="2"> Apache 1.3 is well supported; Apache 2.0 is <strong>not</strong> recommended yet (see TWiki:Support.FailedAuthenticationWithApache2OnWinNT). %BR% For other servers, CGI support, authentication, extended path required </td>
   </tr>
 </table>
 
-Current documentation covers Linux only. Compiling a basic [TWikiOnWindows](http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows) installation guide is an ongoing effort.
+%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._
+
+<a name="ClientRequirements"></a>
 
-## <a name="Client-Side Requirements"></a> Client-Side Requirements
+## <a name="Client Requirements"></a> Client Requirements
 
-The TWiki standard installation has extremely low browser requirements:
+The TWiki [[standard installation|Main/TWikiInstallationGuide]] has extremely low browser requirements:
 
 - HTML 3.2 compliant
+- generates XHTML 1.0 pages that are compatible with HTML 3.2
 - minimal use of JavaScript in the user interface (degrades gracefully)
 - no cookies
 - no CSS
 
-TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
+You can easily add functionality, by customizing [[TWikiTemplates]], for one, while tailoring the browser requirements to your situation.
 
 ## <a name="Known Issues"></a> Known Issues
 
-- The new [[TWikiPlugins]] feature currently does not have any compatibility guidelines for developers. Plugins can require just about anything: browser-specific functions, stylesheets (CSS), Java, cookies, etc.
+- 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.
+  - %H% Plugins included in the TWiki distribution do not add requirements.
 
--- [[MikeMannix]] - 29 Aug 2001
+-- [[MikeMannix]] - 12 Jan 2002