|
TWiki System 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.6.1 or higher (5.8.4 or higher is recommended) |
|
> > |
Perl |
5.8.0 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 |
|
|
> > |
GNU df |
Used by the site statistics to record disk usage statistics, optional. The df command is pre-installed on Linux and OS-X. On Windows install the CoreUtils for Windows. |
|
|
GNU patch |
For upgrades only: GNU patch is required when using the TWiki:Codev.UpgradeTWiki script |
GNU fgrep , egrep |
Modify command line parameters in configure if you use non-GNU grep programs |
|
|
> > |
zip |
Zip archive command line utility. Used by the BackupRestorePlugin to create and restore from backups. |
|
|
Required CPAN Modules |
|
< < | The following Perl modules are used by TWiki:
Module |
Preferred version |
Algorithm::Diff (included in TWiki distribution) |
|
CGI::Carp |
>=1.26 |
Config |
>=0 |
Cwd |
>=3.05 |
Data::Dumper |
>=2.121 |
Encode |
>=2.1 |
Error (included in TWiki distribution) |
|
File::Copy |
>=2.06 |
File::Find |
>=1.05 |
File::Spec |
>=3.05 |
File::Temp |
(included with perl 5.6 and later) |
FileHandle |
>=2.01 |
IO::File |
>=1.10 |
Text::Diff (included in TWiki distribution) |
|
Time::Local |
>=1.11 |
|
> > |
Most of the CPAN libraries listesd below are part of a standard Perl installation so you most likely have them all!
See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries
The following Perl CPAN modules are used by TWiki:
Module |
Preferred version |
Comment |
Algorithm::Diff |
|
Included in TWiki distribution |
CGI |
>=3.18 |
Versions 2.89 and 3.37 must be avoided. Most version from 3.15 and onwards should work. |
CGI::Carp |
>=1.26 |
|
Config |
>=0 |
|
Cwd |
>=3.05 |
|
Data::Dumper |
>=2.121 |
|
Encode |
>=2.1 |
|
Error |
|
Included in TWiki distribution |
File::Copy |
>=2.06 |
|
File::Find |
>=1.05 |
|
File::Spec |
>=3.05 |
|
File::Temp |
>=0.18 |
Included with perl 5.6 and later |
FileHandle |
>=2.01 |
|
HTML::Parser |
>=3.28 |
Needed by the WysiwygPlugin for WYSIWYG editing |
HTML::Entities |
>=1.25 |
Needed by the WysiwygPlugin for WYSIWYG editing |
IO::File |
>=1.10 |
|
Net::SMTP |
>=2.29 |
Used for sending mail |
Text::Diff |
|
Included in TWiki distribution |
Time::Local |
>=1.11 |
|
|
|
Optional CPAN Modules |
|
> > | |
| The following Perl modules may be used by TWiki: |
|
> > |
See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries |
|
|
|
< < |
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 |
|
> > |
Archive::Tar |
|
May be required by the Extensions Installer in configure if command line tar or unzip is not available |
Authen::SASL |
|
Used for SMTP Authentication |
CGI::Cookie |
>=1.24 |
Used for session support |
CGI::Session |
>=3.95 |
Used for session support |
Crypt::SMIME |
>=0.09 |
Required if S/MIME-signed administrative e-mail is enabled. |
Digest::base |
|
|
Digest::SHA1 |
|
|
Locale::Maketext::Lexicon |
>=0 |
Used for I18N support |
Net::SMTP |
>=2.29 |
Used for sending mail |
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: |
| Important note about TWiki Plugins
- Plugins can require just about anything - browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
|
|
> > | %STOPSECTION{"requirements"}% |
|
Related Topics: AdminDocumentationCategory |