EXT: mm_forum¶

What does it do?¶

powersearchindexlucene is an extension to provide indexing capability for Typo3 content and user files in Typo3. The generated index can be used and queried by defined search interface. An implementation to use the query interface is powersearchui .

First an overview of required extensions and their dependencies:

powersearch *–* containsseveral base classes for general search.

powersearchui – displays the search from and renders the result for display on typo3 page.

It is possible to override the default behaviour of the classes in powersearchindexlucene or powersearchui dirs. This will be mostly necessary to adjust the user interface.

Features¶

High performance search – using the popular lucene engine

Out-of-the-box Typo3 indexing

Extensibility – new Indexers can be introduced, existing methods can be overridden

Included Indexers:

Requirements¶

• Zend Framework – is required for lucene indexing and has to be setup ininclude_path
• PHP >= 5.1.6 with PDO (mysql)
• powersearch – common base classes
• for file-indexing capability, the unix-tools "catdoc", "pdf2text" and "cat" have to be available and the path has to be configured in Extension-Manager.
• iconv must be available (with utf8 charset support) for Zend Lucene
• powersearchui – weak requirement, but required to query index and display output

Install extension¶

To run the extension, the extension *powersearch* and the Zend Framework (Version >= 1.5) have to be installed.

The extension is installed and configured using the Extension Manager. The configuration options are explained below:

Alternative path...: can be used for custom modifications to the classes in "lib". Explained below.

Used indexers: Indexer modules to run. Case sensitive!

Directory for index files: directory relative to typo3-root where the index files are placed.

Text lengths: length for index fields where text is truncated. Important to reduce index size.

Directory with files to index: used by "Files" indexer. Directory is traversed recursively.

Location...: path to converters used in File Indexers.

¶

Optimize Index after update: Executes Zend_Search_Lucenes optimize Method. The number of index Files is reduced to gain search speed. Takes a long time depending on indexsize and is cpu intensive.

Enable debug mode: debugging is sent to error_log. Should be off in production!

Creating the index¶

The indexer is run via php CLI call.

Before running the command a CLI be-user named "_CLI_powersearchindexlucene" has to be created. Admin rights are not required. Password has to be something secure, so nobody can use the user. It is not required for the CLI script.

By default the index files are placed into typo3temp/powersearchindexlucene/* so write permissions have to granted to the cli user.

Example : "php /var/www/site/htdocs/typo3conf/ext/powersearchindex lucene/cli/indexer.php"The absolute script path has to be used.

It is recommended to use a crontab entry to recreate the index i.e. once a day at night.

((generated))¶