Skip to content
Pimcore 5.x Website Indexer (powered by Zend Search Lucene)
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update 90_Frontend_Implementation.md Jan 28, 2019
src/LuceneSearchBundle fix HtmlParserEvent (#85) Mar 21, 2019
.gitignore
CODE_OF_CONDUCT.md add community templates Aug 6, 2018
CONTRIBUTING.md
ISSUE_TEMPLATE.md add community templates Aug 6, 2018
LICENSE.md update licence Feb 8, 2017
PULL_REQUEST_TEMPLATE.md add community templates Aug 6, 2018
README.md fix meta annotation and improve crawler event docs Sep 20, 2018
UPGRADE.md add upgrade notes Sep 19, 2018
composer.json fix psr-4 autoload path Aug 6, 2018

README.md

Pimcore 5 Lucene Search

lucenesearch crawler

Requirements

  • Pimcore 5.

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.1.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!

You can’t perform that action at this time.