ModPerlEngineContrib < System

You are here: Foswiki>System Web>ModPerlEngineContrib (01 May 2014, UnknownUser) (raw view)EditAttach
---+!! !ModPerlEngineContrib
<!--
One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = Permits Foswiki to be executed under mod_perl
-->
%SHORTDESCRIPTION%

%TOC%

---++ Overview

This is a runtime engine component from [[Foswiki:Development.FoswikiStandAlone][Foswiki Standalone]] architecture.

[[http://en.wikipedia.org/wiki/Mod_perl][mod_perl]] is the
[[http://perl.apache.org/][Perl API]] to the
[[http://httpd.apache.org/][Apache]] web server. It permits to hook applications
into Apache, providing good performance and great flexibility.

It has better performance than
[[http://en.wikipedia.org/wiki/Common_Gateway_Interface][CGI]] because it loads
and compile apps at apache initialization and apps are kept in memory as long
as apache itself, so there is no need to fork+load+compile all the code for
each request.

---++ Installation Instructions

Install [[Foswiki:Extensions/ModPerlEngineContrib][ModPerlEngineContrib]]
either manually (download the package and extract its contents over your
foswiki directory) or using [[%SCRIPTURL{"configure"}%][configure]] script
(under =Extensions= section, push the =Find More Extensions= button).

Visit the [[Foswiki:Support/ApacheConfigGenerator][apache config generator]]
and fill the fields according to your environment. Select __mod_perl__ as your
__Runtime Engine__ and choose your apache version. Push the ==Update config file== 
button and you'll get your config file.

%X% %RED% When installed for the first time, foswiki *must* be configured. Run
[[%SCRIPTURL{"configure"}%][configure]] script *before* enabling this contrib
or else Apache will not start, reporting an error about missing
lib/LocalSite.cfg %ENDCOLOR%

In the web server configuration you will need to load mod_perl but it is also recommended to load the
[[http://httpd.apache.org/apreq/][Apache HTTP Request Library]] (module apreq).
If apreq is not loaded the following error may be encountered in certain situations e.g. during login:
<verbatim>
apache2: symbol lookup error: /usr/lib/perl5/auto/APR/Request/Apache2/Apache2.so: undefined symbol: apreq_handle_apache2
</verbatim>

---+++ Foswiki configuration tuning

Fork new processes under =mod_perl= can be very slow, so some configuration
changes are recommended.

Access the [[%SCRIPTURL{"configure"}%][configure]] script and click the =Yes, I've read all the documentation=
button to show the expert settings.
Go to =Store Settings=:
   * ={StoreImpl}=: adjust to =RcsLite=
   * ={RCS}{SearchAlgorithm}=: use =Foswiki::Store::SearchAlgorithms::PurePerl= or Foswiki:Extensions/NativeSearchContrib

---++ Known Issues

   * Apache must be restarted in order to configuration changes take effect.
   * The =bin/configure= script is an exception and should be run as a plain 
   CGI script. If you are using some extension that adds files to =bin/= 
   directory you should configure them to be run as plain CGI scripts: since 
   they were not designed to be executed under mod_perl you may face problems. 
   You can replace =Files= directive by
   [[http://httpd.apache.org/docs/2.2/mod/core.html#filesmatch][FilesMatch]] 
   and list all the exceptions.

---++ List of Files

   | *File* | *Description* |
   | ==data/System/ModPerlEngineContrib.txt== | Documentation |
   | ==lib/Foswiki/Contrib/ModPerlEngineContrib.pm== | Perl module |
   | ==lib/Foswiki/Engine/Apache.pm== | Perl module |
   | ==lib/Foswiki/Engine/Apache/MP13.pm== | Perl module |
   | ==lib/Foswiki/Engine/Apache2.pm== | Perl module |
   | ==lib/Foswiki/Engine/Apache2/MP20.pm== | Perl module |
   | ==tools/mod_perl_startup.pl== | Perl script |

---++ Info

|  Author(s): | Foswiki:Main.GilmarSantosJr |
|  Copyright: | &copy; 2009 Gilmar Santos Jr and Foswiki Contributors |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Version: | 5366 (2009-10-23) |
|  Release: | 0.9.2 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  03 Sep 2009 (0.9.2) | Improved documentation regarding module apreq |
|  12 Apr 2009 (0.9.1) | Improved documentation |
|  12 Jan 2009 (0.9.0) | Initial Release |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">mod_perl</td><td align="left">&gt;=1.24</td><td align="left">Required if you're using Apache 1.3</td></tr><tr><td align="left">mod_perl2</td><td align="left">&gt;=2.0</td><td align="left">Required if you're using Apache 2.x</td></tr><tr><td align="left">Apache::Request</td><td align="left">&gt;=1.30</td><td align="left">Recommended if you're using Apache 1.3</td></tr><tr><td align="left">Apache2::Request</td><td align="left">&gt;=2.0</td><td align="left">Recommended if you're using Apache 2.x</td></tr><tr><td align="left">CGI</td><td align="left">&gt;=3.11</td><td align="left">Required if you don't have Apache::Request or Apache2::Request. Otherwise not needed.</td></tr></table> |
|  Home page: | http://foswiki.org/Extensions/ModPerlEngineContrib |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. -->
Topic revision: r1 - 01 May 2014, UnknownUser
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback