Ignore:
Timestamp:
01/24/12 04:40:16 (4 months ago)
Author:
GeorgeClark
Message:

Item11467: Update perl requirements

And some other distribution related information.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/Release01x01/core/data/System/InstallationGuidePart1.txt

    r12748 r13798  
    285285 
    286286#SystemRequirements 
    287 ---+++ Foswiki system requirements 
    288  
    289 Foswiki is capable of running on a variety of operating systems and supporting a wide range of browsers, due to its minimal client and server requirements. 
    290  
    291 ---++++ Server requirements 
    292  
    293 Foswiki is written in Perl 5, which is supported on Microsoft Windows as well as Unix and Unix-like systems (including Linux and OSX), on which it uses a number of shell commands and <a href="http://www.gnu.org/software/rcs/rcs.html" rel="nofollow" target="_top">RCS (Revision Control System)</a>, a GNU Free Software package. It should be able to run on any server platform that meets the following requirements. 
    294  
    295 | *Resource* | *Required Server Environment* | 
    296 | Perl | 5.8.8 or higher is recommended and it will run with Perl >=5.8.4 and <5.8.8 but this is untested. It also runs in Perl 5.6.1 but only with Wysiwyg editor disabled. Wysiwyg requires Unicode support which is provided by perl 5.8.1 onwards. | 
    297 | RCS | 5.7 or higher (including GNU =diff=) <br /> Optional. Foswiki includes a pure Perl implementation of RCS (RcsLite) that can be used instead, at the cost of performance | 
    298 | GNU diff | GNU diff 2.7 or higher is required when not using the all-Perl RcsLite. <br /> Install within the PATH if not included with RCS (check version with =diff -v=) <br /> Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to =diff= | 
    299 | Other external programs | =fgrep, egrep= | 
    300 | Cron/scheduler | &bull; Unix: =cron= <br />&bull; Windows: =cron= equivalents <!-- SMELL: Macintosh version? --> | 
    301 | Web server | Apache is well supported; for information on other servers, see Foswiki:Support.InstallingOnSpecificPlatforms. | 
    302  
    303 ---++++ CPAN modules 
    304  
    305 Most of the <a href="http://cpan.perl.org/" rel="nofollow" target="_top">CPAN</a> libraries used by Foswiki are part of a standard Perl installation >=5.8.8 (recommended). A version >=5.8.4 and <5.8.8 will also work although untested. Please see Foswiki:Support.HowToInstallCpanModules for detailed information on how to install any !CPAN libraries not yet present in your installation. 
    306  
    307 A more complete module status is listed in Foswiki [[%SCRIPTURLPATH{"configure"}%][configure]] (Foswiki 1.0.x: _CGI Setup_, 1.1.x: _Web Server Environment > Perl modules_). It should be easier to deal with CPAN modules from this perspective. 
    308  
    309 The following CPAN modules are shipped with Foswiki, require a comment or may optionally be needed. In case the standard Foswiki will be enhanced with Foswiki:Extensions, please look at the related extension page for dependencies which may require additional modules. Try the script =dependencies_installer.pl= located in the =tools= directory, which makes perl module installation easier. Run it with option =-h= to understand basics. This script requires confirmation before it actually does something. 
    310  
    311 %TABLE{ initsort="3" initdirection="up" }% 
    312 | *Module* | *Preferred version* | *Required/Optional* | *Description* | 
    313 | Algorithm::Diff | | %ORANGE%Required%ENDCOLOR% | *Included* with Foswiki | 
    314 | Apache::Htpasswd | | Optional | May be required for !ApacheHtpasswd password manager | 
    315 | Archive::Tar | | Optional | May be required by the Extensions Installer in configure if command line tar or unzip is not available, since Perl 5.9.3 part of core. | 
    316 | Archive::Zip | | Optional | Alternative to Archive::Tar, used by the Extensions Installer if Archive::Tar also unavailable | 
    317 | CGI | Versions 2.89, 3.37, 3.43, and 3.47 must be avoided. Most versions from 3.15 and onwards should work. | %ORANGE%Required%ENDCOLOR% | *Included* with Perl core since Perl 5.4 | 
    318 | CGI::Session |  | Optional | Required for Sessions support, available from the CPAN archive | 
    319 | Error | | %ORANGE%Required%ENDCOLOR% | *Included* with Foswiki | 
    320 | Digest::SHA | | Optional | May be required for password encryption, since Perl 5.9.3 part of core | 
    321 | Digest::SHA1 | | Optional | | 
    322 | Encode::compat | | Optional | May be required for international characters | 
    323 | HTML::Entities | | Optional | Required for Foswiki:Extensions.WysiwygPlugin | 
    324 | HTML::Parser | | Optional | Required for Foswiki:Extensions.WysiwygPlugin | 
    325 | Lingua::EN::Sentence | | Optional | May be required for generating new language files | 
    326 | Locale::Maketext::Lexicon | &gt;=0 | Optional | Used for !I18N support | 
    327 | LWP | | Optional | Required for the Configure Extensions Installer, and for external URL based INCLUDEs | 
    328 | URI | | Optional | Required by the [[%SCRIPTURLPATH{"configure"}%][configure]] script | 
    329 | Win32::Console | | Optional | May be required for Windows | 
    330  
    331 You can check version numbers with the [[%SCRIPTURLPATH{"configure"}%][configure]] script, or if you're still trying to get to that point, check from the command line (replace "ModuleName" with the name of the module): 
    332  
    333 <verbatim class="bash">perl -le 'use ModuleName; print "ModuleName"->VERSION' </verbatim> 
    334  
    335 #ClientRequirements 
    336 ---++++ Client requirements 
    337  
    338 Browser clients must support the following capabilities: 
    339  
    340    * HTML 3.2 
    341    * Cookie support enabled, if persistent sessions are required 
    342  
    343 Most skins also require CSS and Javascript support. There is a low-fat skin ([[System.PlainSkin][Plain]]) that minimises these requirements. Some skins require newer browser version. The default skin ([[System.PatternSkin][Pattern]]) is tested on IE 6, Safari, and Mozilla 5.0 based browsers (such as Firefox). 
    344  
    345 You can easily select a balance of browser capability versus look and feel. Try the installed skins in the [[skin browser]] and more at Foswiki:Extensions.SkinPackage. 
     287---++ Foswiki system requirements 
     288%INCLUDE{"SystemRequirements"}% 
    346289 
    347290#UploadingFoswikiDistribution 
Note: See TracChangeset for help on using the changeset viewer.