Merge remote branch 'smcv/ready/transient-autoindex'
[ikiwiki.git] / doc / plugins / search.mdwn
blobe95739cf36569171e863e7587c3613bea53f4b50
1 [[!template id=plugin name=search author="[[Joey]]"]]
2 [[!tag type/web]]
4 This plugin adds full text search to ikiwiki, using the
5 [xapian](http://xapian.org/) engine, its
6 [omega](http://xapian.org/docs/omega/overview.html) frontend, and the
7 [[!cpan Search::Xapian]], [[!cpan Digest::SHA]], and [[!cpan HTML::Scrubber]]
8 perl modules.
10 The [[ikiwiki/searching]] page describes how to write search queries.
12 Ikiwiki will handle indexing new and changed page contents. Note that since
13 it only indexes page contents, files copied by the [[rawhtml]] plugin will
14 not be indexed, nor will other types of data files.
16 There is one setting you may need to use in the config file. `omega_cgi` 
17 should point to the location of the omega cgi program. The default location
18 is `/usr/lib/cgi-bin/omega/omega`.