mirror of
https://github.com/silverstripe/silverstripe-fulltextsearch
synced 2024-10-22 14:05:29 +02:00
DOC Update README.md for CMS 5
This commit is contained in:
parent
351728401d
commit
6245ec97f8
30
README.md
30
README.md
@ -4,32 +4,18 @@
|
||||
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
|
||||
Adds support for fulltext search engines like Sphinx and Solr to Silverstripe CMS.
|
||||
Compatible with PHP 7.2
|
||||
|
||||
## Important notes when upgrading to fulltextsearch 3.7.0+
|
||||
|
||||
There are some significant changes from previous versions:
|
||||
|
||||
Draft content will no longer be automatically added to the search index. This new behaviour was previously an
|
||||
opt-in behaviour that was enabled by adding the following line to a search index:
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
composer require silverstripe/fulltextsearch
|
||||
```
|
||||
$this->excludeVariantState([SearchVariantVersioned::class => Versioned::DRAFT]);
|
||||
```
|
||||
|
||||
A new `canView()` check against an anonymous user (i.e. someone not logged in) and a `ShowInSearch` check is now
|
||||
performed by default against all records (DataObjects) before being added to the search index, and also before being
|
||||
shown in search results. This may mean that some records that were previously being indexed and shown in search results
|
||||
will no longer appear due to these additional checks.
|
||||
|
||||
These additional checks have been added with data security in mind, and it's assumed that records failing these
|
||||
checks probably should not be indexed in the first place.
|
||||
|
||||
# Enable indexing of draft content:
|
||||
|
||||
You can index draft content with the following yml configuration:
|
||||
|
||||
```
|
||||
```yaml
|
||||
SilverStripe\FullTextSearch\Search\Services\SearchableService:
|
||||
variant_state_draft_excluded: false
|
||||
```
|
||||
@ -49,7 +35,7 @@ also disable the check for descendants of the specified DataObjects. Ensure that
|
||||
is correctly performing a `canView()` check at query time before disabling the pre-index check, as this may result in
|
||||
leakage of private data.
|
||||
|
||||
```
|
||||
```yaml
|
||||
SilverStripe\FullTextSearch\Search\Services\SearchableService:
|
||||
indexing_canview_exclude_classes:
|
||||
- Some\Org\MyDataObject
|
||||
@ -82,12 +68,6 @@ cached in memory so there is virtually no performance penalty calling it a secon
|
||||
- If your implementation is very custom and does not subclass nor make use of either `SolrIndex` or `SearchForm`, then
|
||||
it's recommended you update your implementation to call `SearchableService::isViewable()`.
|
||||
|
||||
## Requirements
|
||||
|
||||
* Silverstripe 4.0+
|
||||
|
||||
**Note:** For Silverstripe 3.x, please use the [2.x release line](https://github.com/silverstripe/silverstripe-fulltextsearch/tree/2).
|
||||
|
||||
## Documentation
|
||||
|
||||
For pure Solr docs, check out [the Solr 4.10.4 guide](https://archive.apache.org/dist/lucene/solr/ref-guide/apache-solr-ref-guide-4.10.pdf).
|
||||
|
Loading…
Reference in New Issue
Block a user