-**_Platform_**
+<div>
+ <ul>
+ <li><a href="#TWiki System Requirements"> TWiki System Requirements</a><ul>
+ <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>
+ </ul>
+</div>
-TWiki is written in PERL 5, but it uses also many shell command. The current implementation runs only on a Unix machine. RCS for revision control must be installed on the system.
+# <a name="TWiki System Requirements"></a> TWiki System Requirements
-**_Directories_**
+_Server and client requirements for TWiki 01-Feb-2003 (pending release)_
-<table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td> twiki/bin </td>
- <td> TWiki PERL scripts </td>
- </tr>
- <tr>
- <td> twiki/pub </td>
- <td> Public files ([[Main/FileAttachments]], images) </td>
- </tr>
- <tr>
- <td> twiki/data </td>
- <td> source text </td>
- </tr>
- <tr>
- <td> twiki/templates </td>
- <td> HTML templates, used by TWiki scripts </td>
- </tr>
-</table>
+Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.
-**_Files in twiki/bin_**
+## <a name="Server Requirements"></a> Server Requirements
+
+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>
- <th bgcolor="#99CCCC"><strong> File: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td> .htaccess.txt </td>
- <td> Authentication. Rename to .htaccess and customize if used </td>
- </tr>
- <tr>
- <td> attach </td>
- <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
- </tr>
- <tr>
- <td> delete </td>
- <td> (not used yet) </td>
- </tr>
- <tr>
- <td> edit </td>
- <td> Script to edit a topic </td>
- </tr>
- <tr>
- <td> geturl </td>
- <td> Script to fetch URL data </td>
+ <th bgcolor="#99CCCC" colspan="3"><strong> Required Server Environment </strong></th>
</tr>
<tr>
- <td> mailnotify </td>
- <td> Script called by cron job to notify users of changes </td>
+ <th bgcolor="#99CCCC"><strong> Resource </strong></th>
+ <th bgcolor="#99CCCC"><strong> Unix </strong></th>
+ <th bgcolor="#99CCCC"><strong> Windows* </strong></th>
</tr>
<tr>
- <td> oops </td>
- <td> Script that shows a OK or oops dialog </td>
+ <td> Perl </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> preview </td>
- <td> Script to preview topic after edit </td>
+ <td> Non-standard Perl modules </td>
+ <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
+ <td align="center"><code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
</tr>
<tr>
- <td> rdiff </td>
- <td> Script to see differences of topics </td>
+ <td> RCS </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> register </td>
- <td> Script to register new users </td>
+ <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> save </td>
- <td> Script that saves a topic, called by preview </td>
+ <td> Other external programs </td>
+ <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
</tr>
<tr>
- <td> search </td>
- <td> Script that displays search results </td>
+ <td> Cron/scheduler </td>
+ <td align="center"><code>cron</code></td>
+ <td><code>cron</code> equivalents </td>
</tr>
<tr>
- <td> statistics </td>
- <td> Script to create statistics topic </td>
- </tr>
- <tr>
- <td> testenv </td>
- <td> Script to test CGI environment variables </td>
- </tr>
- <tr>
- <td> upload </td>
- <td> Script that does file upload ([[Main/FileAttachment]]) </td>
- </tr>
- <tr>
- <td> view </td>
- <td> Script to view a topic ( <strong>the</strong> script ) </td>
- </tr>
- <tr>
- <td> viewfile </td>
- <td> Script to view an file attachment </td>
- </tr>
- <tr>
- <td> wiki.pm </td>
- <td> main TWiki library </td>
- </tr>
- <tr>
- <td> wikicfg.pm </td>
- <td> for initialization and configuration, used by wiki.pm </td>
- </tr>
- <tr>
- <td> wikisearch.pm </td>
- <td> search engine, used by wiki.pm </td>
+ <td> Web server </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>
--- [[PeterThoeny]] - 19 Aug 2000 <br />
+%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 Requirements"></a> Client 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
+
+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 [[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]] - 12 Jan 2002
git://git.openafs.org / openafs-wiki.git / blobdiff