[Easterhegg2013] [TitleIndex] [WordIndex

Using Xapian you can dramatically improve the performance of searching in moin and furthermore unlock some more features (see the search prefixes above) not possible with the legacy search engine.

Setting it up


You must have Xapian itself and its Python bindings (xapian-core and xapian-bindings) from http://www.xapian.org/ at least in version 1.0.6 installed. In addition, Windows users need to install pywin32 from http://sourceforge.net/projects/pywin32/.

To process attachment files, moin uses filter plugins - here is the list of filter plugins included:

File type



Text files (.txt)


tries utf-8 and iso-8859-15 encodings (or forces to ASCII if those do not work)

JPEG images (.jpg)


EXIF data is extracted

Open Office files (.sx?)


e.g. from older OpenOffice.org/StarOffice versions

Open Document files (.od?)


e.g. from recent OpenOffice.org/StarOffice versions

Binary files


moin uses a strings like filter to process those, as well as a blacklist with stuff you don't want to search

MS Word files (.doc)


filter calls antiword

MS Excel files (.xls)


filter calls xls2csv

MS Powerpoint files (.ppt)


filter calls catppt

PDF files (.pdf)

xpdf-utils or poppler-utils

filter calls pdftotext

After installing additional filters (or dependencies) you should (re)build your index. Xapian will find the new filters / support packages automagically. The next time your search results may contain results linking directly to your attachments.


In your wikiconfig, you have several options on how to configure Xapian:

Xapian search

Configuration of the Xapian based indexed search, see HelpOnXapian.

Variable name Default Description
xapian_index_dir None Directory where the Xapian search index is stored (None = auto-configure wiki local storage)
xapian_index_history False True to enable indexing of non-current page revisions.
xapian_search False True to enable the fast, indexed search (based on the Xapian search library)
xapian_stemming False True to enable Xapian word stemmer usage for indexing / searching.

(Re-)Building an index

You can use the supplied command line tool moin to initially build, completely rebuild or update an existing index.

To (re-)build your index please execute:

moin --config-dir=/where/your/configdir/is --wiki-url=wiki-url/ index build --mode=rebuild

For more information about the moin index command, see HelpOnMoinCommand.

/!\ Please note that you must rebuild your index if you change any of the xapian_index_history, xapian_index_dir or xapian_stemming configuration options!


You can test if Xapian is enabled and if an index is available by checking SystemInfo. To check if searches are performed using Xapian, enable show_timings in your wikiconfig, perform a search and look for _xapianSearch on the bottom of the page.


Xapian is basically used the same way as all other search engines. Due to Xapian's advanced features some new search term prefixed were introduced which are not already available in the legacy search engine (commonly referred to as moin search). See HelpOnSearching for more information and/or use the new advanced search dialogue available on FindPage to see what's available and possible.

2013-07-19 18:27