| |
TWiki System Requirements |
|
<
< | Server and client requirements for TWiki 01-Sep-2004 |
>
> | Server and client requirements |
| | |
|
<
< | Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions. |
>
> | Low client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions. Many Plugins and contrib modules exist which enhance and expand TWiki's capabilities; they may have additional requirements. |
| | Server Requirements
TWiki is written in Perl 5, uses a number of shell commands, and requires RCS (Revision Control System), 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.
|
|
<
< |
| Perl | 5.005_03 or higher (5.6.1 recommended, 5.8.x does work in most cases, but see TWiki:Codev.IssuesWithPerl5dot8) |
| Non-standard Perl modules | • Unix: Net::SMTP (or sendmail)
• Windows: Net::SMTP, MIME::Base64, Digest::SHA1
• Internationalisation: Unicode::MapUTF8 (only for non-ISO-8859-1 sites using TWiki:Codev.EncodeURLsWithUTF8 with Perl 5.6 or lower) |
| RCS | 5.7 or higher (including GNU diff)
Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite |
|
>
> |
| Perl | 5.005_03 or higher (5.8.4 or higher is recommended) |
| RCS | 5.7 or higher (including GNU diff)
Optional, TWiki includes a pure perl implementation of RCS that can be used instead (although it's slower) |
|
| |
GNU diff | GNU diff 2.7 or higher is required when not using the all-Perl RcsLite.
Install on PATH if not included with RCS (check version with diff -v)
Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to diff |
| Other external programs | fgrep, egrep |
|
|
<
< |
| Cron/scheduler | • Unix: cron
• Windows: cron equivalents |
| Web server | Apache 1.3 is well supported; Apache 2.0 is not recommended yet (see TWiki:Codev.IssuesWithApache2dot0).
For other servers, CGI support, authentication, extended path info required; also, the register script is likely to need significant changes |
|
>
> |
|
| | |
|
<
< |  * 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. |
>
> | Required CPAN Modules
The following Perl modules are used by TWiki:
| Module | Preferred version |
|---|
| Algorithm::Diff (included) | |
| CGI::Carp | >=1.26 |
| Config | >=0 |
| Cwd | >=3.05 |
| Data::Dumper | >=2.121 |
| Error (included) | |
| File::Copy | >=2.06 |
| File::Find | >=1.05 |
| File::Spec | >=3.05 |
| FileHandle | >=2.01 |
| IO::File | >=1.10 |
| Text::Diff (included) | |
| Time::Local | >=1.11 |
Optional CPAN Modules
The following Perl modules may be used by TWiki:
| Module | Preferred version | Description |
|---|
| CGI::Cookie | >=1.24 | Used for session support |
| CGI::Session | >=3.95 | Used for session support |
| Digest::base | | |
| Digest::SHA1 | | |
| Jcode | | Used for I18N? support with perl 5.6 |
| Locale::Maketext::Lexicon | >=0 | Used for I18N? support |
| Net::SMTP | >=2.29 | Used for sending mail |
| Unicode::Map | | Used for I18N? support with perl 5.6 |
| Unicode::Map8 | | Used for I18N? support with perl 5.6 |
| Unicode::MapUTF8 | | Used for I18N? support with perl 5.6 |
| Unicode::String | | Used for I18N? support with perl 5.6 |
| URI | | Used for configure |
Most of them will probably already be available in your installation. You can check version numbers with the configure script, or if you're still trying to get to that point, check from the command line like this:
perl -e 'use FileHandle; print $FileHandle::VERSION."\n"'
<--
SMELL: perhaps put download link to TWiki:Plugins.CpanContrib? (which
also includes prebuilt versions of all of the CPAN modules used by
all of the plugins checked into SVN)
--> |
| |
Client Requirements |
|
<
< | The TWiki standard installation has extremely low browser requirements: |
>
> | The TWiki standard installation has relatively low browser requirements: |
| | |
|
<
< |
- 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 (if the ClassicSkin is used)
|
>
> |
- Cookies, if persistent sessions are required
|
| | |
|
<
< | You can easily add functionality, by customizing TWikiTemplates, for one, while tailoring the browser requirements to your situation. |
>
> | CSS and Javascript are used in most skins, although there is a low-fat skin (Classic skin) available that minimises these requirements. Some skins will require more recent releases of browsers. The default skin (Pattern) is tested on IE 6, Safari, and Mozilla 5.0 based browsers (such as Firefox).
<--
SMELL: what are some actual known good version number requirements for these browsers (eg, FireFox? 1.0, or 1.0.3, or 1.0.7, or ???), etc.
--> |
| | |
|
<
< | Known Issues |
>
> | You can easily select a balance of browser capability versus look and feel. Try the installed skins at TWikiSkinBrowser and more at TWiki:Plugins.SkinPackage. |
| | |
|
<
< |
- 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.
-
 Plugins included in the TWiki distribution do not add requirements.
|
>
> | Important note about TWiki Plugins |
| | |
|
<
< | -- TWiki:Main.MikeMannix - 12 Jan 2002
-- TWiki:Main.PeterThoeny - 15 Aug 2004 |
>
> |
- Plugins can require just about anything - browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
-
 Note: Plugins included in the TWiki distribution do not add requirements, except for the CommentPlugin which requires Perl 5.6.1.
|
| | |
|
<
< |
| META TOPICMOVED | by="PeterThoeny" date="1042701667" from="TWiki.TWikiImplementationNotes" to="TWiki.TWikiSystemRequirements" |
|---|
|
>
> | Related Topics: AdminDocumentationCategory |