Skip to content

Commit

Permalink
Item9986: Clarify installation steps
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/trunk@10885 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
GeorgeClark authored and GeorgeClark committed Mar 1, 2011
1 parent be18044 commit b324f8a
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions core/data/System/InstallationGuide.txt
Expand Up @@ -69,9 +69,11 @@ _If you have root user permissions_, then for additional security, you can chang

If Foswiki stops working after you applied a change in access permissions and you wish to restore the original permissions, run the Unix commands located at Foswiki:Support.SettingFileAccessRightsLinuxUnix.

---+++ Configure the locations of the Perl executable and the Foswiki modules
---+++ (optional) Configure the locations of the Perl executable and the Foswiki modules

*Make sure the Foswiki scripts can be executed by the web server.* The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script (you may have to give yourself write permission first) in the =bin= and =tools= directories. You can use the =tools/rewriteshebang.pl= script to do this; for example:
If you are running on a Linux system with Perl found in =/usr/bin/perl= then this step is not required. This step is *required* on Windows installations.

Find the location of your system's Perl interpreter. Change the path to Perl in the first line of each script (you may have to give yourself write permission first) in the =bin= and =tools= directories. You can use the =tools/rewriteshebang.pl= script to do this; for example:
<verbatim class="bash">
cd /path/to/foswiki/bin
/path/to/perl ../tools/rewriteshebang.pl
Expand All @@ -82,8 +84,14 @@ cd /path/to/foswiki/tools
/path/to/perl rewriteshebang.pl
</verbatim>

---+++ (optional) Configuration of a script suffix for the perl scripts

Some web servers require a special extension on perl script files (e.g. =.cgi= or =.pl=). This is not normally required with the Apache web server, though some hosted web servers are configured to require it. If the documentation for your web server indicates that a special extension is necessary, rename all the executable scripts in =bin=; that is, rename =bin/view= to =bin/view.pl=, and so on. When configuring Foswiki (see the section "[[#ConfigureFoswiki][Configure Foswiki]]"), set the =ScriptSuffix= option to the special extension.

---+++ (optional) Configuration for non-standard library locations

A standard Foswiki install has the directories =bin/= and =lib/= located under the Foswiki installation directory. If you have moved these directories, or if your system requires changes to the default Perl libraries, then this step is required.

*Create the file Local<nop>Lib.cfg* located at =bin/LocalLib.cfg=
* In the =bin= directory, copy the template file =LocalLib.cfg.txt= to =LocalLib.cfg=. Make sure the ownership and access rights of the copy are the same as <nop>Local<nop>Lib.cfg.txt.
* Edit =bin/LocalLib.cfg= so that =$foswikiLibPath= is set to the absolute file path of your =lib= directory. For example: =/path/to/foswiki/lib=.
Expand Down Expand Up @@ -141,6 +149,7 @@ For more information, refer to Foswiki:Support.ProtectingYourConfiguration.
* Setup the =Mail and Proxies= section. The ={WebMasterEmail}= and ={SMTP}{MAILHOST}= settings must be defined so Foswiki can send registration emails. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set ={SMTP}{Username}= and ={SMTP}{Password}=. If you do not want to enable sending registration emails or want to enable it later you can uncheck ={EnableEmail}=.
If your server is behind a firewall with a proxy, and you wish to install extensions via =configure=, you may have to set ={PROXY}{HOST}= and ={PROXY}{PORT}=.
<blockquote class="foswikiHelp">%X% %INCLUDE{"UserAuthentication" section="SMTPNOTE"}%</blockquote>
<blockquote class="foswikiHelp"}%X% SMTP authentication requires additional perl modules including =Authen::SASL= and =MIMI::Base64=, </blockquote>

If there is a problem with your setup that prevents you from accessing the =configure= page, you can [[#ConfiguringFoswikiManually][configure Foswiki manually]].

Expand Down

0 comments on commit b324f8a

Please sign in to comment.