Changeset 6329


Ignore:
Timestamp:
02/15/10 05:06:16 (2 years ago)
Author:
WillNorris
Message:

Item8498: doc tweaks

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/ModPerlEngineContrib/data/System/ModPerlEngineContrib.txt

    r5366 r6329  
    1414[[http://en.wikipedia.org/wiki/Mod_perl][mod_perl]] is the 
    1515[[http://perl.apache.org/][Perl API]] to the 
    16 [[http://httpd.apache.org/][Apache]] web server. It permits to hook applications 
     16[[http://httpd.apache.org/][Apache]] web server. It permits hooking applications 
    1717into Apache, providing good performance and great flexibility. 
    1818 
    1919It has better performance than 
    2020[[http://en.wikipedia.org/wiki/Common_Gateway_Interface][CGI]] because it loads 
    21 and compile apps at apache initialization and apps are kept in memory as long 
    22 as apache itself, so there is no need to fork+load+compile all the code for 
     21and compiles apps at Apache initialization and apps are kept in memory as long 
     22as Apache itself, so there is no need to fork+load+compile all the code for 
    2323each request. 
    2424 
    … …  
    2727Install [[Foswiki:Extensions/ModPerlEngineContrib][ModPerlEngineContrib]] 
    2828either manually (download the package and extract its contents over your 
    29 foswiki directory) or using [[%SCRIPTURL{"configure"}%][configure]] script 
     29foswiki directory) or using [[%SCRIPTURL{"configure"}%][configure]] 
    3030(under =Extensions= section, push the =Find More Extensions= button). 
    3131 
    3232Visit the [[Foswiki:Support/ApacheConfigGenerator][apache config generator]] 
    33 and fill the fields according to your environment. Select __mod_perl__ as your 
     33and fill in the fields according to your environment. Select __mod_perl__ as your 
    3434__Runtime Engine__ and choose your apache version. Push the ==Update config file==  
    3535button and you'll get your config file. 
    3636 
    37 %X% %RED% When installed for the first time, foswiki *must* be configured. Run 
    38 [[%SCRIPTURL{"configure"}%][configure]] script *before* enabling this contrib 
    39 or else Apache will not start, reporting an error about missing 
    40 lib/LocalSite.cfg %ENDCOLOR% 
     37%X% %RED% When installed for the first time, Foswiki *must* be configured. Run 
     38[[%SCRIPTURL{"configure"}%][configure]] *before* enabling this contrib 
     39or else Apache will not start, reporting an error about a missing 
     40=lib/LocalSite.cfg= %ENDCOLOR% 
    4141 
    42 In the web server configuration you will need to load mod_perl but it is also recommended to load the 
     42In the web server configuration, you will need to load =mod_perl= but it is also recommended to load the 
    4343[[http://httpd.apache.org/apreq/][Apache HTTP Request Library]] (module apreq). 
    44 If apreq is not loaded the following error may be encountered in certain situations e.g. during login: 
     44If =apreq= is not loaded, the following error may be encountered in certain situations, e.g., during login: 
    4545<verbatim> 
    4646apache2: symbol lookup error: /usr/lib/perl5/auto/APR/Request/Apache2/Apache2.so: undefined symbol: apreq_handle_apache2 
    4747</verbatim> 
    4848 
     49---+++ Confirming =mod_perl= installation 
     50 
     51You may (though not necessarily) be able to confirm that =mod_perl= is installed and enabled by checking 
     52in configure's "Environment Variables" section.  a sample: 
     53 
     54| SERVER_SIGNATURE | Apache/2.2.9 (Debian) mod_apreq2-20051231/2.6.0 mod_perl/2.0.4 Perl/v5.10.0 Server at 127.0.0.1 Port 2116 | 
     55| SERVER_SOFTWARE | Apache/2.2.9 (Debian) mod_apreq2-20051231/2.6.0 mod_perl/2.0.4 Perl/v5.10.0 | 
     56 
     57Another technique to see which modules are enabled is using =apache2ctl= 
     58<verbatim> 
     59$ apache2ctl -M | grep perl_module 
     60 perl_module (shared) 
     61</verbatim> 
     62If not found, enable mod_perl with  
     63<verbatim> 
     64$ a2enmod mod_perl 
     65</verbatim> 
     66 
     67 
    4968---+++ Foswiki configuration tuning 
    5069 
    51 Fork new processes under =mod_perl= can be very slow, so some configuration 
     70Forking new processes under =mod_perl= can be very slow, so some configuration 
    5271changes are recommended. 
    5372 
    … …  
    6079---++ Known Issues 
    6180 
    62    * Apache must be restarted in order to configuration changes take effect. 
     81   * Apache must be =restart=ed in order for configuration changes take effect. 
    6382   * The =bin/configure= script is an exception and should be run as a plain  
    64    CGI script. If you are using some extension that adds files to =bin/=  
    65    directory you should configure them to be run as plain CGI scripts: since  
    66    they were not designed to be executed under mod_perl you may face problems.  
     83   CGI script.  The required =SetHandler cgi-script= should already be specified 
     84   in the =<Files configure.*>= in your Apache config or =bin/.htaccess= file. 
     85<blockquote><verbatim> 
     86   <FilesMatch "configure.*"> 
     87      SetHandler cgi-script 
     88      . 
     89      . 
     90   </FilesMatch> 
     91</verbatim></blockquote> 
     92   * If you are using some extension that add files to the =bin/=  
     93   directory, you may face problems as they were not designed to be executed  
     94   under =mod_perl=.  You should configure them to be run as plain CGI scripts. 
    6795   You can replace =Files= directive by 
    6896   [[http://httpd.apache.org/docs/2.2/mod/core.html#filesmatch][FilesMatch]]  
    … …  
    86114|  12 Jan 2009 (0.9.0) | Initial Release | 
    87115|  Dependencies: | %$DEPENDENCIES% | 
    88 |  Home page: | http://foswiki.org/Extensions/ModPerlEngineContrib | 
     116|  Home page: | http://foswiki.org/Extensions/%TOPIC% | 
     117|  Support: | http://foswiki.org/Support/%TOPIC% | 
    89118 
    90119<!-- Do _not_ attempt to edit this topic; it is auto-generated. --> 
Note: See TracChangeset for help on using the changeset viewer.