dachcom-digital/lucene-search

Pimcore 5.x Website Indexer (powered by Zend Search Lucene)

Pimcore Lucene Search

, _(*1)

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., _(*2)

Requirements

• Pimcore >= 5.8
• Pimcore >= 6.0

Pimcore 4

Get the Pimcore4 Version here., _(*3)

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:, _(*4)

lucene_search:
    enabled: true

A complete setup could look like this:, _(*5)

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:, _(*6)

# 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., _(*7)

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., _(*8)

Command Line Command
If you want to start the crawler manually, use this command:, _(*9)

$ php bin/console lucenesearch:crawl -f -v

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., _(*10)

Further Information

• Categories: Learn more about category based crawling / searching.
• Custom Header: Learn how to add custom headers to the crawler request (like a auth token).
• Restrictions: Learn more about restricted crawling / indexing.
• Custom Meta Content: Learn more about crawling / searching custom meta.
• Crawler Events: Hook into crawler process to add custom fields to index.
• Lucene Document Modification: Remove or change availability of lucene documents within a pimcore update/deletion event.
• Frontend Implementation: Get a step by step walkthrough to implement lucene search into your website.

Copyright and license

Copyright: DACHCOM.DIGITAL
For licensing details please visit LICENSE.md, _(*11)

Upgrade Info

Before updating, please check our upgrade notes!, _(*12)