- Timestamp:
- 11/24/08 01:10:49 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/NativeSearchContrib/data/TWiki/NativeSearchContrib.txt
r530 r898 7 7 %SHORTDESCRIPTION% 8 8 9 By default TWiki searches its database by [[http://en.wikipedia.org/wiki/Fork_%28operating_system%29][forking]] the standard [[http://en.wikipedia.org/wiki/Grep][grep]] program in a sub-process to search through the text files in the database cache. This is usually pretty fast, but unfortunately in some environments (specifically with [[http://perl.apache.org/][mod_perl]]) forking a sub-process is very expensive, and another approach is needed.9 By default Foswiki searches its database by [[http://en.wikipedia.org/wiki/Fork_%28operating_system%29][forking]] the standard [[http://en.wikipedia.org/wiki/Grep][grep]] program in a sub-process to search through the text files in the database cache. This is usually pretty fast, but unfortunately in some environments (specifically with [[http://perl.apache.org/][mod_perl]]) forking a sub-process is very expensive, and another approach is needed. 10 10 11 !NativeSearch is a c-code module that can be plugged into TWiki to replace the default searching algorithm. It publishes an [[http://en.wikipedia.org/wiki/XS_(Perl)][XS]] interface that allows it to be called from Perl, without having to fork a sub-process. It has comparable performance to the standard forking search in most environments, but is often significantly faster than forked search when TWiki is run under a CGI accelerator. The effect is most pronounced with mod_perl, but is also there for [[http://www.daemoninc.com/SpeedyCGI/][SpeedyCGI]].11 !NativeSearch is a c-code module that can be plugged into Foswiki to replace the default searching algorithm. It publishes an [[http://en.wikipedia.org/wiki/XS_(Perl)][XS]] interface that allows it to be called from Perl, without having to fork a sub-process. It has comparable performance to the standard forking search in most environments, but is often significantly faster than forked search when Foswiki is run under a CGI accelerator. The effect is most pronounced with mod_perl, but is also there for [[http://www.daemoninc.com/SpeedyCGI/][SpeedyCGI]]. 12 12 13 *You require shell access to the server to install this module*. Refer to TWiki:Codev.NativeSearch for a list of systems where the module has been successfully compiled and installed (and please update it if you find a new one).13 *You require shell access to the server to install this module*. 14 14 15 15 ---++ Installation Instructions … … 27 27 ---+++ Building the c-code 28 28 29 =cd= to the root directory in your TWiki installation. Now, _assuming you have administrator (root) access to the server:_29 =cd= to the root directory in your Foswiki installation. Now, _assuming you have administrator (root) access to the server:_ 30 30 <verbatim> 31 31 $ cd tools/native_search … … 43 43 install. Follow the steps above, but use =perl Makefile.PL INSTALLBASE=/your/dir= to install to a different directory. Exactly where you install depends on your system configuration. 44 44 45 Now, in [[%SCRIPTURL{configure}%][configure]], under "Store Settings", you should be able to select the search algorithm = TWiki::Store::SearchAlgorithms::Native= (click the <input type="button" style="background-color:#eef" value="Yes, I've read all the documentation"/> button first if you have TWiki 4.2 or later).45 Now, in [[%SCRIPTURL{configure}%][configure]], under "Store Settings", you should be able to select the search algorithm =Foswiki::Store::SearchAlgorithms::Native= (click the <input type="button" style="background-color:#eef" value="Yes, I've read all the documentation"/> button first if you have TWiki 4.2 or later or Foswiki). 46 46 47 Run a TWiki search, and watch the web server error log for any problems.47 Run a Foswiki search, and watch the web server error log for any problems. 48 48 49 49 Because performance can differ widely between two apparently similar webserver configurations, you are recommended to do your own benchmarking and select the search algorithm that performs best for you. … … 51 51 ---++ Contrib Info 52 52 53 Another great TWiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience!53 Another great Foswiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience! 54 54 55 55 Many thanks to the following sponsors for supporting this work:
Note: See TracChangeset
for help on using the changeset viewer.
