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/SystemRequirements.txt

    r12748 r13798  
    1 %META:TOPICINFO{author="ProjectContributor" date="1284973002" format="1.1" version="1"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1291655311" format="1.1" version="1"}% 
    22%META:TOPICPARENT{name="ReferenceManual"}% 
     3---+!! Foswiki System Requirements 
    34%STARTINCLUDE% 
    4 ---+ System Requirements 
    55 
    6 _Server and client requirements_ 
     6Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platforms and versions. Many extensions exist which enhance and expand Foswiki's capabilities; they may have additional requirements. 
    77 
    8 Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platforms and versions.  Many extensions exist which enhance and expand Foswiki's capabilities; they may have additional requirements. 
     8%TOC{title="Contents"}% 
    99 
    10 %TOC% 
     10---+++ Server Requirements 
    1111 
    12 ---++ Server Requirements 
     12Foswiki 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. 
    1313 
    14 The code is written in Perl 5, and uses a number of shell commands from perl. 
    15 The default package requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. Foswiki 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. 
    16  
    17 | *Resource* | *Required Server Environment *<nop>* | 
    18 | Perl | 5.8.0 or higher (5.8.4 or higher is recommended) | 
    19 | RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, Foswiki includes a pure perl implementation of RCS that can be used instead (although it's slower) | 
    20 | GNU =diff= | GNU =diff= 2.7 or higher is required when not using the all-Perl <nop>RcsLite.  %BR% Install on 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= | 
    21 | GNU =patch= | For upgrades only: GNU =patch= is required when patching the code using patches in diff format submitted by the community. | 
    22 | GNU =fgrep=, =egrep= | Modify command line parameters in configure if you use non-GNU grep programs | 
    23 | Cron/scheduler | %BULLET% Unix: =cron= %BB% Windows: =cron= equivalents <!-- SMELL: Macintosh version? --> | 
    24 | Web server | Apache is well supported; see Foswiki:Support.InstallingOnSpecificPlatforms for alternative options. | 
     14| *Resource* | *Required Server Environment* | 
     15| Perl | 5.8.8 or higher | 
     16| 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 | 
     17| 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= | 
     18| Other external programs | =fgrep, egrep= | 
     19| Cron/scheduler | &bull; Unix: =cron= <br />&bull; Windows: =cron= equivalents <!-- SMELL: Macintosh version? --> | 
     20| Web server | Apache is well supported; for information on other servers, see Foswiki:Support.InstallingOnSpecificPlatforms. | 
    2521 
    2622---+++ Perl Modules 
     23 
    2724A complete list of the required and optional Perl modules can be found in =lib/DEPENDENCIES=. 
    2825 
     26The following CPAN modules are not shipped with Foswiki. Note that Foswiki extensions may add additional requirements. 
     27Modules marked as Required may still be optional if certain default core features are not used. 
     28 
     29| *Module* | *Required/Optional* | *Description* | 
     30| CGI::Session | Required | Sessions support is usually required. | 
     31| HTML::Entities | Required | Used for [[Foswiki:Extensions.WysiwygPlugin][WYSIWYG Editing]] | 
     32| HTML::Parser | Required | Used for [[Foswiki:Extensions.WysiwygPlugin][WYSIWYG Editing]] | 
     33| HTML::Tree | Required | Used by CompareRevisionAddOn. | 
     34| URI | Required | Used for email notifications of topic changes. [[Foswiki::Extensions.MailerContrib][MailerContrib]] | 
     35| LWP | Required | Used by the Configure Extensions Installer, and for external URL based INCLUDEs | 
     36| Digest::SHA | Optional | Required to use SHA1 password encoding, since Perl 5.9.3 part of core | 
     37| Crypt::PasswdMD5 | Optional | Required to use Apache or Crypt MD5 password encoding, and crypt encoding on Windows | 
     38| Digest::SHA1 | Optional | Required by the Foswiki FileCache feature | 
     39| Win32::Console | Optional | May be required for I18N on Windows | 
     40| Archive::Tar | Optional | Required by the Extensions Installer in configure if command line tar or unzip is not available, since Perl 5.9.3 part of core. | 
     41| Archive::Zip | Optional | Alternative to Archive::Tar, used by the Extensions Installer if Archive::Tar and command line tar and unzip also unavailable | 
     42| Net::SMTP::SSL | Optional | Required by Net::SMPT to send email over SSL to providers such as gmail. | 
     43| Authen::SASL | Optional | Required by Net::SMTP if email server requires authentication. | 
     44 
     45 
    2946Most 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: 
    30 <!--%JQREQUIRE{"chili"}%--><verbatim class="bash"> 
     47<verbatim class="bash"> 
    3148perl -e 'use FileHandle; print $FileHandle::VERSION."\n"' 
    3249</verbatim> 
     50For more detailed dependency information, 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. 
    3351 
     52---+++ Specific distribution details 
     53<noautolink> 
     54---++++!! Ubuntu and other Debian derived distributions 
     55%TWISTY{ showlink="Show Debian / Ubuntu information" hidelink="Hide Debian details"}% 
    3456 
     57Install apache and rcs ==apt-get install apache2 rcs== 
     58 
     59| *Perl Module* | *Package to install* | *Notes* | 
     60| CGI::Session | =libcgi-session-perl= | | 
     61| HTML::Parser | =libhtml-parser-perl= | | 
     62| HTML::Entities | | included with HTML::Parser | 
     63| HTML::Tree | =libhtml-tree-perl= | | 
     64| LWP | =libwww-perl= | | 
     65| Digest::SHA | =libdigest-sha-perl= | | 
     66| Digest::SHA1 | =libdigest-sha1-perl= | | 
     67| URI | =liburi-perl= | | 
     68| Crypt::PasswdMD5 | =libcrypt-passwdmd5-perl= | | 
     69| Net::SMTP::SSL | =libnet-smtp-ssl= | | 
     70| Authen::SASL | =libauthen-sasl= | note, broken on Ubuntu 11.10 x64.  Install using CPAN! | 
     71 
     72After expanding the Foswiki archive, change the ownership of the files: 
     73   * Debian, Ubuntu, Kubunto: =chown -R www-data:www-data /path/to/foswiki= 
     74 
     75%ENDTWISTY{}% 
     76 
     77---++++!! RedHat, SuSE, CentOS and other RPM based distributions 
     78%TWISTY{ showlink="Show RetHat, SuSE and other RPM details" hidelink="Hide RPM details"}% 
     79 
     80Install apache2, rcs, and perl-CPAN 
     81 
     82| *Perl Module* | *Package to install* | *Notes* | 
     83| CGI::Session | =perl-CGI-Session= | | 
     84| HTML::Parser | =perl-HTML-Parser= | | 
     85| HTML::Entities | | included with HTML::Parser | 
     86| HTML::Tree | =perl-HTML-Tree= | | 
     87| LWP | =perl-libwww-perl= | | 
     88| Digest::SHA | =perl-Digest-SHA= | | 
     89| Digest::SHA1 | =perl-Digest-SHA1= | | 
     90| URI | =perl-URI= | | 
     91| Crypt::PasswdMD5 | =perl-Crypt-PasswdMD5= | | 
     92| Net::SMTP::SSL | =perl-Net-SMPT-SSL= | | 
     93| Authen::SASL | =perl-Authen-SASL= | | 
     94 
     95After expanding the Foswiki archive, change the ownership of the files: 
     96   * RedHat, Fedora, CentOS Mandriva: chown -R apache:apache /path/to/foswiki= 
     97   * Suse: =chown -R wwwrun:www /path/to/foswiki= 
     98 
     99%ENDTWISTY{}% 
     100 
     101</noautolink> 
    35102#ClientRequirements 
    36 ---++ Client Requirements 
     103---+++ Client Requirements 
    37104 
    38105The [[InstallationGuide][standard installation]] has relatively low browser requirements: 
    … …  
    42109   * Javascript, for edit/save/upload functionality <blockquote class="foswikiHelp">%T% Change ={ValidationMethod}{Method}= from =strikeone= to =embedded= in [[%SCRIPTURLPATH{"configure"}%][configure]] to allow non-javascript browsers to edit/save/upload</blockquote> 
    43110 
    44 CSS and Javascript are used in most skins. Some skins will require more recent releases of browsers. The default skin is tested on IE 6, 7, Safari 3.0, and recent Mozilla based browsers (such as Firefox). 
     111CSS and Javascript are used in most skins. Some skins will require more recent releases of browsers. The default skin is tested on IE 6+, Safari, Chrome and Firefox. 
    45112 
    46113You can easily select a balance of browser capability versus look and feel. Try the installed skins at %SYSTEMWEB%.SkinBrowser and more at Foswiki:Extensions.SkinPackage. 
    47114 
    48 ---++ Important note about Plugins 
    49  
    50    * Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs. 
    51  
     115%STOPINCLUDE% 
    52116--- 
    53117*Related Topics:* AdminDocumentationCategory 
     118 
     119<!--%JQREQUIRE{"chili"}%--> 
Note: See TracChangeset for help on using the changeset viewer.