{"id":20213814,"url":"https://github.com/dachcom-digital/pimcore-lucene-search","last_synced_at":"2026-03-07T08:03:17.695Z","repository":{"id":56961215,"uuid":"52678148","full_name":"dachcom-digital/pimcore-lucene-search","owner":"dachcom-digital","description":"Pimcore Website Indexer (powered by Zend Search Lucene)","archived":false,"fork":false,"pushed_at":"2019-11-01T15:43:19.000Z","size":592,"stargazers_count":26,"open_issues_count":5,"forks_count":20,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-10-06T02:22:14.603Z","etag":null,"topics":["crawler","lucene","lucenesearch","pimcore"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dachcom-digital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-27T17:12:26.000Z","updated_at":"2022-09-03T03:12:22.000Z","dependencies_parsed_at":"2022-08-21T09:20:44.653Z","dependency_job_id":null,"html_url":"https://github.com/dachcom-digital/pimcore-lucene-search","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/dachcom-digital/pimcore-lucene-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dachcom-digital%2Fpimcore-lucene-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dachcom-digital%2Fpimcore-lucene-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dachcom-digital%2Fpimcore-lucene-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dachcom-digital%2Fpimcore-lucene-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dachcom-digital","download_url":"https://codeload.github.com/dachcom-digital/pimcore-lucene-search/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dachcom-digital%2Fpimcore-lucene-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crawler","lucene","lucenesearch","pimcore"],"created_at":"2024-11-14T06:11:55.072Z","updated_at":"2026-03-07T08:03:17.409Z","avatar_url":"https://github.com/dachcom-digital.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pimcore Lucene Search\n![lucenesearch crawler](https://cloud.githubusercontent.com/assets/700119/25579028/7da66f40-2e74-11e7-8da5-988d61feb2e2.jpg)\n\n## Note\nThe Pimcore Lucene Search Bundle will be marked as abandoned as soon the [Dynamic Search Bundle](https://github.com/dachcom-digital/pimcore-dynamic-search) reached a stable state.\nAfter that, bugfixing will be supported in some cases. However, PRs are always welcome.\n\n### Requirements\n- Pimcore \u003e= 5.8\n- Pimcore \u003e= 6.0\n\n#### Pimcore 4 \nGet the Pimcore4 Version [here](https://github.com/dachcom-digital/pimcore-lucene-search/tree/pimcore4).\n\n### Installation  \n1. Add code below to your `composer.json`    \n2. Activate \u0026 install it through the ExtensionManager\n\n```json\n\"require\" : {\n    \"dachcom-digital/lucene-search\" : \"~2.3.0\"\n}\n```\n\n### Configuration\nTo enable LuceneSearch, add those lines to your `AppBundle/Resources/config/pimcore/config.yml`:\n    \n```yaml\nlucene_search:\n    enabled: true\n```\n\nA complete setup could look like this:\n\n```yaml\nlucene_search:\n    enabled: true\n    fuzzy_search_results: false\n    search_suggestion: true\n    seeds:\n        - 'http://your-domain.dev'\n    filter:\n        valid_links:\n            - '@^http://your-domain.dev.*@i'\n    view:\n        max_per_page: 10\n    crawler:\n        content_max_size: 4\n        content_start_indicator: '\u003c!-- main-content --\u003e'\n        content_end_indicator: '\u003c!-- /main-content --\u003e'\n```\n\nYou need to add the config parameter to your config.yml to override the default values. \nExecute this command to get some information about all the config elements of LuceneSearch:\n\n```bash\n# configuration about all config parameters\n$ bin/console config:dump-reference LuceneSearchBundle\n\n# configuration info about the \"fuzzy_search_results\" parameter\n$ bin/console config:dump-reference LuceneSearchBundle fuzzy_search_results\n```\n\nWe also added a [detailed documentation](docs/00_Configuration_Values.md) about all possible config values.\n\n### Features\n* Maintenance driven indexing\n* Auto Complete\n* Restricted Documents \u0026 Usergroups ([member](https://github.com/dachcom-digital/pimcore-members) plugin recommended but not required)\n\n### Usage\n\n**Default**  \nThe crawler Engine will start automatically every night by default. Please check that the pimcore default maintenance script is properly installed.\n\n**Command Line Command**  \nIf you want to start the crawler manually, use this command:\n\n```\n$ php bin/console lucenesearch:crawl -f -v\n```\n\n| command | short command | type | description |\n|:---|:---|:---|:---|\n| ```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 |\n| ```verbose``` | `-v` | show some logs | good for debugging. you'll get some additional information about filtered and forbidden links while crawling. |\n\n## Logs\nYou'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.\n**Note:** please enable the debug mode in pimcore settings to get all types of logs.\n\n## Further Information\n\n- [Categories](docs/20_Categories.md): Learn more about category based crawling / searching.\n- [Custom Header](docs/29_Custom_Request_Header.md): Learn how to add custom headers to the crawler request (like a auth token).\n- [Restrictions](docs/30_Restrictions.md): Learn more about restricted crawling / indexing.\n- [Custom Meta Content](docs/40_Meta.md): Learn more about crawling / searching custom meta.\n- [Crawler Events](docs/50_Crawler_Events.md): Hook into crawler process to add custom fields to index.\n- [Lucene Document Modification](docs/60_Document_Modification.md): Remove or change availability of lucene documents within a pimcore update/deletion event.\n- [Frontend Implementation](docs/90_Frontend_Implementation.md): Get a step by step walkthrough to implement lucene search into your website.\n\n## Copyright and license\nCopyright: [DACHCOM.DIGITAL](http://dachcom-digital.ch)  \nFor licensing details please visit [LICENSE.md](LICENSE.md)  \n\n## Upgrade Info\nBefore updating, please [check our upgrade notes!](UPGRADE.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdachcom-digital%2Fpimcore-lucene-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdachcom-digital%2Fpimcore-lucene-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdachcom-digital%2Fpimcore-lucene-search/lists"}