Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dachcom-digital/pimcore-lucene-search
Pimcore Website Indexer (powered by Zend Search Lucene)
https://github.com/dachcom-digital/pimcore-lucene-search
crawler lucene lucenesearch pimcore
Last synced: about 1 month ago
JSON representation
Pimcore Website Indexer (powered by Zend Search Lucene)
- Host: GitHub
- URL: https://github.com/dachcom-digital/pimcore-lucene-search
- Owner: dachcom-digital
- License: other
- Created: 2016-02-27T17:12:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-01T15:43:19.000Z (about 5 years ago)
- Last Synced: 2024-10-20T11:53:53.467Z (2 months ago)
- Topics: crawler, lucene, lucenesearch, pimcore
- Language: PHP
- Homepage:
- Size: 578 KB
- Stars: 26
- Watchers: 18
- Forks: 20
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pimcore Lucene Search
## Note
The 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.
After that, bugfixing will be supported in some cases. However, PRs are always welcome.
### Requirements
- Pimcore >= 5.8
- Pimcore >= 6.0
#### Pimcore 4
Get the Pimcore4 Version [here](https://github.com/dachcom-digital/pimcore-lucene-search/tree/pimcore4).
### Installation
1. Add code below to your `composer.json`
2. Activate & install it through the ExtensionManager
```json
"require" : {
"dachcom-digital/lucene-search" : "~2.3.0"
}
```
### Configuration
To enable LuceneSearch, add those lines to your `AppBundle/Resources/config/pimcore/config.yml`:
```yaml
lucene_search:
enabled: true
```
A complete setup could look like this:
```yaml
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:
```bash
# 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
* Maintenance driven indexing
* Auto Complete
* Restricted Documents & Usergroups ([member](https://github.com/dachcom-digital/pimcore-members) 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
- [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: [DACHCOM.DIGITAL](http://dachcom-digital.ch)
For licensing details please visit [LICENSE.md](LICENSE.md)
## Upgrade Info
Before updating, please [check our upgrade notes!](UPGRADE.md)