PHPackages                             pringuin/pimcore-lucene-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. pringuin/pimcore-lucene-search

ActivePimcore-bundle[Search & Filtering](/categories/search)

pringuin/pimcore-lucene-search
==============================

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

v4.2.0(10mo ago)58902[1 issues](https://github.com/pringuin/pimcore-lucene-search/issues)GPL-3.0+PHP

Since Apr 12Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/pringuin/pimcore-lucene-search)[ Packagist](https://packagist.org/packages/pringuin/pimcore-lucene-search)[ Docs](https://github.com/pringuin/pimcore-lucene-search)[ RSS](/packages/pringuin-pimcore-lucene-search/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (35)Used By (0)

Pimcore Lucene Search
=====================

[](#pimcore-lucene-search)

[![lucenesearch crawler](https://cloud.githubusercontent.com/assets/700119/25579028/7da66f40-2e74-11e7-8da5-988d61feb2e2.jpg)](https://cloud.githubusercontent.com/assets/700119/25579028/7da66f40-2e74-11e7-8da5-988d61feb2e2.jpg)

Note
----

[](#note)

This is a fork of the original dachcom-digital/pimcore-lucene-search repository. Dachcom did not update this bundle for Pimcore X in favor of the [Dynamic Search Bundle](https://github.com/dachcom-digital/pimcore-dynamic-search)

This includes changes by [yosoDev](https://github.com/yosoDev) and [beheist](https://github.com/beheist), thanks a lot!

### Requirements

[](#requirements)

- Pimcore >= 11

#### Pimcore 10

[](#pimcore-10)

Use the version 3.X for Pimcore 10

#### Pimcore 5/6

[](#pimcore-56)

Get the Pimcore 5/6 Version [here](https://github.com/dachcom-digital/pimcore-lucene-search).

#### Pimcore 4

[](#pimcore-4)

Get the Pimcore4 Version [here](https://github.com/dachcom-digital/pimcore-lucene-search/tree/pimcore4).

### Installation

[](#installation)

1. Add code below to your `composer.json`
2. Activate & install it through the ExtensionManager

```
"require" : {
    "pringuin/pimcore-lucene-search" : "~4.0.0"
}
```

### Configuration

[](#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: ''
        content_end_indicator: ''
```

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](docs/00_Configuration_Values.md) about all possible config values.

### Features

[](#features)

- Maintenance driven indexing
- Auto Complete
- Restricted Documents & Usergroups ([member](https://github.com/dachcom-digital/pimcore-members) plugin recommended but not required)

### Usage

[](#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

```

commandshort commandtypedescription`force``-f`force crawler startsometimes 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 logsgood for debugging. you'll get some additional information about filtered and forbidden links while crawling.Logs
----

[](#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
-------------------

[](#further-information)

- [Categories](docs/20_Categories.md): Learn more about category based crawling / searching.
- [Custom Header](docs/29_Custom_Request_Header.md): Learn how to add custom headers to the crawler request (like a auth token).
- [Restrictions](docs/30_Restrictions.md): Learn more about restricted crawling / indexing.
- [Custom Meta Content](docs/40_Meta.md): Learn more about crawling / searching custom meta.
- [Crawler Events](docs/50_Crawler_Events.md): Hook into crawler process to add custom fields to index.
- [Lucene Document Modification](docs/60_Document_Modification.md): Remove or change availability of lucene documents within a pimcore update/deletion event.
- [Frontend Implementation](docs/90_Frontend_Implementation.md): Get a step by step walkthrough to implement lucene search into your website.

Copyright and license
---------------------

[](#copyright-and-license)

Copyright: [DACHCOM.DIGITAL](http://dachcom-digital.ch)
For licensing details please visit [LICENSE.md](LICENSE.md)

Upgrade Info
------------

[](#upgrade-info)

Before updating, please [check our upgrade notes!](UPGRADE.md)

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance50

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 86.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~109 days

Recently: every ~268 days

Total

32

Last Release

306d ago

Major Versions

v1.6.0 → v2.0.02017-10-02

v1.6.1 → v2.1.02018-03-21

v1.6.2 → v2.3.22019-10-10

v2.3.2 → v3.0.02022-03-23

v3.2.0 → v4.0.02023-08-21

### Community

Maintainers

![](https://www.gravatar.com/avatar/a5188113904743698c8e4796905c7628fc830975233b914af8160711407cde9d?d=identicon)[Cruiser13](/maintainers/Cruiser13)

---

Top Contributors

[![solverat](https://avatars.githubusercontent.com/u/700119?v=4)](https://github.com/solverat "solverat (205 commits)")[![Cruiser13](https://avatars.githubusercontent.com/u/2771909?v=4)](https://github.com/Cruiser13 "Cruiser13 (11 commits)")[![dpfaffenbauer](https://avatars.githubusercontent.com/u/5981845?v=4)](https://github.com/dpfaffenbauer "dpfaffenbauer (8 commits)")[![ktallafus](https://avatars.githubusercontent.com/u/17338820?v=4)](https://github.com/ktallafus "ktallafus (7 commits)")[![LosHawlos](https://avatars.githubusercontent.com/u/7881418?v=4)](https://github.com/LosHawlos "LosHawlos (2 commits)")[![vintagesucks](https://avatars.githubusercontent.com/u/13335308?v=4)](https://github.com/vintagesucks "vintagesucks (1 commits)")[![alasdair-shields](https://avatars.githubusercontent.com/u/23553071?v=4)](https://github.com/alasdair-shields "alasdair-shields (1 commits)")[![ToKruAmApp](https://avatars.githubusercontent.com/u/77840536?v=4)](https://github.com/ToKruAmApp "ToKruAmApp (1 commits)")[![aarongerig](https://avatars.githubusercontent.com/u/17384333?v=4)](https://github.com/aarongerig "aarongerig (1 commits)")

---

Tags

searchpimcorelucene

### Embed Badge

![Health badge](/badges/pringuin-pimcore-lucene-search/health.svg)

```
[![Health](https://phpackages.com/badges/pringuin-pimcore-lucene-search/health.svg)](https://phpackages.com/packages/pringuin-pimcore-lucene-search)
```

###  Alternatives

[elasticsearch/elasticsearch

PHP Client for Elasticsearch

5.3k178.3M943](/packages/elasticsearch-elasticsearch)[ruflin/elastica

Elasticsearch Client

2.3k50.4M203](/packages/ruflin-elastica)[dachcom-digital/lucene-search

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

2640.3k](/packages/dachcom-digital-lucene-search)[solarium/solarium

PHP Solr client

93532.7M98](/packages/solarium-solarium)[opensearch-project/opensearch-php

PHP Client for OpenSearch

15024.3M65](/packages/opensearch-project-opensearch-php)[mmanos/laravel-search

A search package for Laravel 5.

36475.7k1](/packages/mmanos-laravel-search)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)