Contact Contact Show All Awards & Recognition
Contact
Show All Awards & Recognition

LuceneSearch

recently-reviewed

last reviewed: 30.07.2018

CMS and Frontend Modules

Author:

DACHCOM

Version

v2.3.2

Last updated

Contact

-

0  Reviewer

LuceneSearch

CMS and Frontend Modules

Project Summary

Pimcore Website Indexer (powered by Zend Search Lucene). Abandoned - Use Dynamic Search!


Readme

Pimcore Lucene Search

lucenesearch crawler

Note

The Pimcore Lucene Search Bundle will be marked as abandoned as soon the Dynamic Search Bundle reached a stable state. After that, bugfixing will be supported in some cases. However, PRs are always welcome.

Requirements

  • Pimcore >= 5.8
  • Pimcore >= 6.0

Pimcore 4

Get the Pimcore4 Version here.

Installation

  1. Add code below to your composer.json
  2. Activate & install it through the ExtensionManager
"require" : {
    "dachcom-digital/lucene-search" : "~2.3.0"
}

Configuration

To enable LuceneSearch, add those lines to your AppBundle/Resources/config/pimcore/config.yml:

lucene_search:
    enabled: true

A complete setup could look like this:

lucene_search:
    enabled: true
    fuzzy_search_results: false
    search_suggestion: true
    seeds:
        - 'http://your-domain.dev'
    filter:
        valid_links:
            - '@^http://your-domain.dev.*@i'
    view:
        max_per_page: 10
    crawler:
        content_max_size: 4
        content_start_indicator: '<!-- main-content -->'
        content_end_indicator: '<!-- /main-content -->'

You need to add the config parameter to your config.yml to override the default values. Execute this command to get some information about all the config elements of LuceneSearch:

# configuration about all config parameters
$ bin/console config:dump-reference LuceneSearchBundle

# configuration info about the "fuzzy_search_results" parameter
$ bin/console config:dump-reference LuceneSearchBundle fuzzy_search_results

We also added a detailed documentation about all possible config values.

Features

  • Maintenance driven indexing
  • Auto Complete
  • Restricted Documents & Usergroups (member plugin recommended but not required)

Usage

Default
The crawler Engine will start automatically every night by default. Please check that the pimcore default maintenance script is properly installed.

Command Line Command
If you want to start the crawler manually, use this command:

$ php bin/console lucenesearch:crawl -f -v
command short command type description
force | -f force crawler start sometimes the crawler stuck because of a critical error mostly triggered because of wrong configuration. use this command to force a restart
verbose | -v show some logs good for debugging. you'll get some additional information about filtered and forbidden links while crawling.

Logs

You'll find some logs from the last crawl in your backend (at the bottom on the LuceneSearch settings page). Of course you'll also find some logs in your var/logs folder. Note: please enable the debug mode in pimcore settings to get all types of logs.

Further Information

Copyright and license

Copyright: DACHCOM.DIGITAL
For licensing details please visit LICENSE.md

Upgrade Info

Before updating, please check our upgrade notes!

Review status

recently-reviewed

last reviewed: 30.07.2018

?>

Author:

DACHCOM

Version

v2.3.2

Last updated

Contact

-

0  Reviewer