2c342d471df41691679e45b2f0579f7594a04de5
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Requirements"> TWiki Requirements</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Server-Side Requirements"> Server-Side Requirements</a></li>
6         <li><a href="#Client-Side Requirements"> Client-Side 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 Requirements"></a> TWiki Requirements
14
15 _Server and client system requirements; file system structure_
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-Side Requirements"></a> Server-Side Requirements
22
23 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.
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="right"><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. Compiling a basic [TWikiOnWindows](http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows) installation guide is an ongoing effort.
58
59 ## <a name="Client-Side Requirements"></a> Client-Side Requirements
60
61 The TWiki standard installation has extremely low browser requirements:
62
63 - HTML 3.2 compliant
64 - minimal use of JavaScript in the user interface (degrades gracefully)
65 - no cookies
66 - no CSS
67
68 TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
69
70 ## <a name="Known Issues"></a> Known Issues
71
72 - 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.
73
74 -- [[MikeMannix]] - 29 Aug 2001