Changeset 13799


Ignore:
Timestamp:
01/24/12 04:43:23 (4 weeks ago)
Author:
GeorgeClark
Message:

Item11467: Update docs for Perl Modules

Also add some basic information on different distributions.

Location:
trunk/core/data/System
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/core/data/System/CompleteDocumentation.txt

    r12750 r13799  
    99 
    1010------ 
     11---++ System Requirements 
    1112%INCLUDE{"SystemRequirements"}% 
    1213 

  • trunk/core/data/System/InstallationGuide.txt

    r13151 r13799  
    1414If you need help, feel free to ask a question in the Foswiki:Support web or on Foswiki:Community.InternetRelayChat (irc.freenode.net, channel #foswiki). 
    1515 
     16This guide assumes the person installing Foswiki has a basic knowledge of server administration on the system on which Foswiki is to be installed, as described at Foswiki:System.AdminSkillsAssumptions. 
     17 
    1618---++ Before Installing Foswiki 
    1719 
    18 This guide assumes the person installing Foswiki has a basic knowledge of server administration on the system on which Foswiki is to be installed, as described at Foswiki:System.AdminSkillsAssumptions. 
    19  
    20 Please see the [[Foswiki:System.SystemRequirements][Foswiki system requirements]] for the server and client requirements to run Foswiki, including the Perl modules required on the server. If you need to install any Perl libraries from CPAN for use by Foswiki, see Foswiki:Support.HowToInstallCpanModules for more information. 
     20Please see the [[#SystemRequirements][System Requirements]] (below) for server and client requirements to run Foswiki, including the Perl modules required on the server. If you need to install any Perl libraries from CPAN for use by Foswiki, see Foswiki:Support.HowToInstallCpanModules for more information. 
    2121 
    2222---++ 5-Minute Install 
    … …  
    4141If you do not have shell access to your web server host, see the section "[[#UploadingFoswikiDistribution][Uploading the Foswiki distribution to your web server host]]". 
    4242 
    43 ---+++ Step 2: Set the file and directory permissions for the installation 
    44  
    45 _NOTE: You can skip this step if you are on Windows._ 
    46 <div class="foswikiHelp"> Shouldn't this also talk about changing file 
    47 ownership.  =chown -R . www:www=  or =apache:apache= or =wwwdata:wwwdata= 
    48 depending upon your distribution?  </div> 
     43---+++ Step 2: Set the file and directory ownership and permissions for the installation 
     44 
     45_Note: You can skip this step on Windows_ 
     46 
     47File ownership depends upon the operating system and distribution. 
     48 
     49| RedHat, Fedora, CentOS, Gentoo, Mandriva | =chown -R apache:apache path/to/foswiki= | 
     50| debian, Ubuntu, Kubuntu | =chown -R www-data:www-data /path/to/foswiki= | 
     51| Suse | =chown -R wwwrun:www /path/to/foswiki= | 
    4952 
    5053The default file and directory access permissions as set by the distribution define a reasonable security level that will work for many types of installations, including shared hosting. Nonetheless, you should verify that the web server user has read access to all files and directories beneath the =foswiki= directory, and execute access for all directories. Also verify that the =data= and =pub= directories and all the subdirectories and files beneath them allow write access for the web server user. 
    … …  
    242245If a plugin exists both in a TWiki version and a Foswiki version, it is strongly recommended that you use the Foswiki version, as this is coded to work optimally with Foswiki. As part of the Foswiki project, the Foswiki community is evaluating all of the extensions that are available for TWiki, and porting them over to the Foswiki name space. Many of them are being enhanced through the removal of bugs and security vulnerabilities, resulting in better, more functional extensions for Foswiki. 
    243246 
     247#SystemRequirements 
     248---++ System Requirements 
     249%INCLUDE{"SystemRequirements"}% 
     250 
    244251*Related Topics:* [[InstallationGuidePart2]], [[AdminDocumentationCategory]], Foswiki:Support.SupplementalDocuments 
    245252 

  • trunk/core/data/System/SystemRequirements.txt

    r13797 r13799  
    11%META:TOPICINFO{author="ProjectContributor" date="1291655311" format="1.1" version="1"}% 
    22%META:TOPICPARENT{name="ReferenceManual"}% 
     3---+!! Foswiki System Requirements 
    34%STARTINCLUDE% 
    4 ---+!! Foswiki System Requirements 
    55 
    66Low 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. 
    … …  
    88%TOC{title="Contents"}% 
    99 
    10 ---++ Server Requirements 
     10---+++ Server Requirements 
    1111 
    1212Foswiki 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. 
    … …  
    2020| Web server | Apache is well supported; for information on other servers, see Foswiki:Support.InstallingOnSpecificPlatforms. | 
    2121 
    22 ---++ Perl Modules 
     22---+++ Perl Modules 
    2323 
    2424A complete list of the required and optional Perl modules can be found in =lib/DEPENDENCIES=. 
    … …  
    5050For 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. 
    5151 
    52 ---++ Specific distribution details 
     52---+++ Specific distribution details 
    5353<noautolink> 
     54---++++!! Ubuntu and other Debian derived distributions 
    5455%TWISTY{ showlink="Show Debian / Ubuntu information" hidelink="Hide Debian details"}% 
    55 ---+++!! Ubuntu and other Debian derived distributions 
    5656 
    5757Install apache and rcs ==apt-get install apache2 rcs== 
    … …  
    7575%ENDTWISTY{}% 
    7676 
     77---++++!! RedHat, SuSE, CentOS and other RPM based distributions 
    7778%TWISTY{ showlink="Show RetHat, SuSE and other RPM details" hidelink="Hide RPM details"}% 
    78 ---+++!! RedHat, SuSE, CentOS and other RPM based distributions 
    7979 
    8080Install apache2, rcs, and perl-CPAN 
    … …  
    101101</noautolink> 
    102102#ClientRequirements 
    103 ---++ Client Requirements 
     103---+++ Client Requirements 
    104104 
    105105The [[InstallationGuide][standard installation]] has relatively low browser requirements: 
    … …  
    113113You 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. 
    114114 
     115%STOPINCLUDE% 
    115116--- 
    116117*Related Topics:* AdminDocumentationCategory 
Note: See TracChangeset for help on using the changeset viewer.