Installation

Last updated August 12, 2010. Created by cpliakas on July 16, 2009.
Edited by NadimBak. Log in to edit this page.

Before installing Search Lucene API, make sure you review the Installing contributed modules tutorial. Search Lucene API is installed like any standard Drupal module with one exception; The required Zend Framework components must be downloaded separately. Due to Drupal's strict licensing policy regarding non-GPL code, the ZF components cannot be bundled with the module on Drupal.org. However, no action other than retrieving the files from the Search Lucene API Library project on SourceForge.net and moving the extracted directory to the correct location is required. Complete installation instructions are as follows:

Download the Search Lucene API module from the project page. Make sure the version of the module matches your version of Drupal. For example, the 6.x-2.0 version is suitable for Drupal 6 but will not work for Drupal 5.
Extract the files. Modules downloaded from drupal.org are compressed to reduce their size and must be extracted before they can be used on your website. The result of this action will be a 'luceneapi' directory containing the module's source code files. For a tutorial on how to extract compressed files, please refer to the “Installing contributed modules” tutorial.
Download the required Zend Framework components from the Search Lucene API Library project on SourceForge.net. Match the release of the ZF components to the version of the module downloaded in step 1. For example, the 6.x-2.0 version of Search Lucene API requires the 6.x-2.0 version of the ZF components. If there is no exact match, download the latest available version of the ZF components up to, but not exceeding, the minor version of the downloaded module. The Status report page in the administration section of your website will alert you if the ZF components require updating.

Project page: http://sourceforge.net/projects/luceneapi

Extract the ZF components files as done in step 2. The result of this action will be a directory named 'lib'.

Move the 'lib' directory into the 'luceneapi' directory. From this point forward, it is assumed the 'luceneapi/lib' directory contains the requires ZF components.

Upload the 'luceneapi' directory to your Drupal installation. In most cases, the module will reside in 'sites/all/modules'. Please refer to the "Installing contributed modules" tutorial for more information.

Enable the modules. Navigate to Administer > Site building > Modules and check the 'Enabled' box next to Search Lucene API and Search Lucene Content. Scroll down to the bottom of the page and click the 'Save Configuration' button.

As of Search Lucene API 6.x-2.0-beta3, the Search Lucene Content index can be populated via a batch process by visiting Administer > Site configuration > Search Lucene Content and clicking on the Index statistics tab. Once there, select the Rebuild index after operation checkbox and click the Re-index button. It is critical that cron is configured otherwise changes to the content will not be reflected in the search index. For more information on configuring cron, please refer to the Configuring cron jobs tutorial. It is worth noting that Search Lucene API is compatible with projects such as Super Cron.

Comments

elysia_cron looks good too...

Posted by shunting on July 25, 2009 at 6:43pm

... though I'm not sure how Elysia integrates with Luceneapi yet.

The two should really join forces.

http://www.universalpantograph.com

Search Lucene API implements

Posted by cpliakas on August 15, 2009 at 11:06pm

Search Lucene API implements the core Search API. Since Search Lucene Content has a hook_update_index() function, indexing ultimately happens when search_cron() is run. Therefore, all versions of Search Lucene API should already be able to integrate with the project mentioned above. Thanks for the recommendation!

Great work!

Posted by the_spy on January 26, 2010 at 11:02am

Our first impressions are very good - well done so far!

One question I do have is: does this module stop Drupal core search from indexing nodes, or is that something we need to disable ourselves? Your module relies on core search being enabled but it's not that obvious to us what the implications are. Hope you can clarify...

Other than that, keep up the good work!

Mani

Excited! But fell at the first hurdle

Posted by rymercho on May 14, 2010 at 11:37am

I have been looking a implementing lucene but headaches ensued.

This looks great but I have an install problem :(...

I downloaded the api and corresponding elements (Zend etc.) dropped the lib folder in to the lucene api directory. When I came to initialise the modules I got this error.

Fatal error: Class 'LuceneAPI_Search_Lucene_Analysis_Analyzer_Drupal' not found in /Library/WebServer/Documents/drupal/sites/all/modules/luceneapi/luceneapi.module on line 134

This locked me out of the modules panel so I went to the file and commented out:

Zend_Search_Lucene_Analysis_Analyzer::setDefault(new $analyzer());
Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength(0);

I can't see what I have done wrong, any ideas?

Looking forward to playing with this.

Possible I got a version

Posted by rymercho on May 14, 2010 at 12:14pm

Possible I got a version mixed up.
I was using luceneapi 1.6-2.2 and lib files for 1.6-2.0

I went back version and have no errors

Please use issue queue

Posted by cpliakas on July 13, 2010 at 2:27pm

Just a friendly reminder to please use the issue queue for any problems with the module.

Leaving "Filesystem: Index Path" files out of revision control

Posted by GaryWong on June 2, 2011 at 2:36am

Hi,

I've just started playing with Search Lucene API, and so far, it's been seamless to install and use. One quick question, can I safely leave the index files (e.g. *.cfs, *.file, segments.gen, write.lock.file, etc) out of my revision control?

When I'm really to deploy my Drupal install (i.e. git archive), can I include the /luceneapi_node directory but forget the files? At my production site, I assume Search Lucene APU will just show 0% indexed content; I can them simply Rebuild the index from /settings/luceneapi_node/statistics?

TIA

Gary

---
Victoria, BC
Canada

I can't see the Configuration Tab of Lucene after installing

Posted by squeezer44 on July 3, 2011 at 6:12pm

As I followed the instructions of this installation guide in step 8 I can't see the configuration at Administer > Site configuration > Search Lucene Content.
I took the luceneapi 6.x-2.0 and luceneapi-lib-6.x-2.0-beta4.
Please help - what's wrong?

Thanks in advance