Giter VIP home page Giter VIP logo

pimcore-lucene-search's Introduction

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!

pimcore-lucene-search's People

Contributors

solverat avatar ktallafus avatar dpfaffenbauer avatar aarongerig avatar cruiser13 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.