Extension:EzMwLucene

MediaWiki extensions manual - list

EzMwLucene Release status: beta
Implementation	Search
Description	This project provides a simplified Lucene search to Mediawiki.
Author(s)	Chris Reigrut, Key Bank / Key Equipment Finance
Last version	1.0.0 (05/07/2009)
MediaWiki	1.13
License	GPL
Download	Sourceforge
Parameters $wgEzMwLuceneQueryUrl, $wgEzMwLuceneIndexUrl
Check usage and version matrix

The extension EzMwLucene provides a simplified Lucene search to Mediawiki. It is designed to be easy to install, configure, and run. It provides real-time, multiple field indexing and searching as well as text indexing of standard attachment types (pdf, xls, doc, ppt, vsd). The server is a self contained Java application (no application server needed), and the client portion is a standard Mediawiki extension. It is currently in production on an internal site with over 1000 users running on Mediawiki 1.13.

Requirements

• Java 1.6+
• php_curl package

Installation

after EzMwLucene Installation Guide; See also the discussion page with quite a bit of trouble.

Setting up the server (Guide for Version 1.0)

1. Extract the tarball
2. Move the server directory to the directory of your choosing (here /srv/search/lucene/)
3. Move the client/extensions/EzMwLucene directory to your Mediawiki extensions directory
4. Modify ezmwlucene.properties (in the server directory) as needed with your information, see below
5. If you're adding this to an existing wiki, you probably want to run the loader (see below) to preload documents (otherwise, they'll only be added to the index the next time they are updated)
6. Modify service.sh if necessary for your environment
7. Run service.sh start

Edit ezmwlucene.properties manually

Assure correspondence to LocalSettings.php

 lucene.index = /srv/search/lucene/index                          # location of the index
 server.port = 8080                                               # in $wgEzMwLuceneQueryUrl below
 mediawiki.name = Testwiki                                        # =$wgSitename
 #mediawiki.databaseDriverClass = com.mysql.jdbc.Driver
 mediawiki.databaseUrl = jdbc:mysql://localhost:3306/wikidb       # jdbc:mysql://$wgDBserver:DATABASEPORT/$wgDBname
 mediawiki.databaseUser = wikiUserName                            # =$wgDBuser
 mediawiki.databasePassword = WikiUserPassword                    # =$wgDBpassword
 mediawiki.imagesUrl = http://127.0.0.1/wiki/images/              # =URL/$wgScriptPath/images/
 mediawiki.localImagesUrl = file:///srv/www/htdocs/wiki/images/   # =DOCROOT/$wgScriptPath/images/

(Having a proper install script would be nice). The mediawiki.database settings are only needed for the initial loader phase.

Running loader.sh once in the set up phase

The loader script indexes the current set of documents, which is pulled directly from the wiki database. It assumes no database prefix (if $wgDBprefix is not empty, see work around in discussion page)

Changes to LocalSettings.php

$wgEzMwLuceneQueryUrl

The URL of the Query service

$wgEzMwLuceneIndexUrl

The URL of the Index service

$wgEzMwLuceneQueryUrl = 'http://localhost:8080/query';
$wgEzMwLuceneIndexUrl = 'http://localhost:8080/index';
$wgSearchType = 'EzMwLuceneSearchEngine';
require_once("extensions/EzMwLucene/EzMwLucene.php");

(with the URLs modified as needed) 8080 = server.port entry in property file above

Revision History

1.0.0 (05/07/2009)

Initial release

svn

 svn co https://ezmwlucene.svn.sourceforge.net/svnroot/ezmwlucene ezmwlucene

Comments

Pro:

• real-time indexing of text and attachments

Cons:

• The claim "designed to be easy to install" is not at all realized yet. See discussion page
• unicode support missing

Open Questions

• Does it support 1.15+ ? (I do have this working on 1.15.1 on Windows 2003 server, with the patch for wgDBprefix --Mark 12:12, 7 December 2009 (UTC) )
• Does it support 1.14+ ?
• how does is work with user right and access access extention?
• "unicode support" urgently needed

Yes, I have it now working on 1.17 and intend to provide updates/patches soon. cmoman

Sites using this extension

Please add your site (and a link if it is public) to the list! Thanks!

• Key National Finance WiKey (internal intranet)

• Stanford Physical Medicine and Rehabilitation Residency Program Knowledge Base (intranet)