A silverstripe module providing search with elasticsearch
Silverstripe module to provide site-wide content search with elasticsearch
composer require somardesignstudios/silverstripe-elastic-search
log folder in the root of the project with permissions allowing write to the user running the siteAdd your elasticsearch API keys to the .env file
# Elastic search
ELASTIC_CLOUD_ID=""
ELASTIC_INDEX=""
ELASTIC_API_ID=""
ELASTIC_API_KEY=""
Page content will be flattened and stored in a standard set of fields defined in this module's search.yml
You can add additional fields by adding a search.yml config to your own project. e.g.
---
Name: my_search
After:
- "#somar_search"
---
Somar\Search\ElasticSearchService:
mappingProperties:
custom_field_one:
type: text
store: true
custom_field_two:
type: date
store: trueYou can change the default search fields and its weightings in config file, optionally you can define highlighting matches in matched fields:
Somar\Search\ElasticSearchService:
searchFields:
- title^2
- keywords^2.5
- content
highlightFields:
- contentOn the Search page you will find a Vue component that is configurable via .yml files:
Somar\Search\PageType\SearchPage:
searchConfig:
headingLevel: 1
allowEmptyKeyword: false
secondarySearch: documents
icons: material # adds material icon into the keyword field & dropdown tag close
caretIconClass: "icon-dropdown" # adds <i class="icon-dropdown"> to dropdowns
labels:
title: Start typing to search the content # all title fields & subtitle can have placeholders and html
titleFound: "Search results for <b>â[searchedKeyword]â</b>"
titleSearching: "Searching for <b>â[keyword]â</b> ..."
subtitle: "[resultsCount] results found"
resultLinkText: Read more # uses URL of the result when not defined
filtersHint: Refine your search results below by selecting popular filters and/or ordering them by date.
filters:
type:
placeholder: Type of content
field: type
columns: 4 # width out of 12 columns on desktop, defaults to 6, set to 6 on tablet & 12 on mobile
multiple: true # allows multiple values selected
showInline: true # display all options inline rather than in dropdown
default: news # preselected filter
searchable: false
iconClass: icon-type # adds <i class="icon-type"> to dropdowns
options:
news:
name: News
filter: App\Page\NewsArticle
events:
name: Events
filter: App\Page\Event
content:
name: Content
filter:not:
- App\Page\NewsArticle
- App\Page\Event
- App\Model\Document
documents:
name: Documents
filter: App\Model\Document
date:
placeholder: By date
field: sort_date
options:
desc:
name: Most recent first
asc:
name: Oldest first
range:
name: Select datesYou can add additional configurations sets when multiple search pages with different configurations are needed. When an additional search type is defined, a dropdown will appear on the Search page. Configuration of additional search type is then merged with the default one.
Somar\Search\PageType\SearchPage:
searchTypes:
documents:
name: Document library
presets:
type: documents
allowEmptyKeyword: true
labels:
title: Search publications
filters:
topics:
placeholder: Topics
field: topics
multiple: true
tag: App\Model\Topic
categories:
placeholder: Categories
field: categories
multiple: true
tag: App\Model\Category
regions:
placeholder: Regions
field: regions
multiple: true
tag: App\Model\Region
date:
field: publishedTo create the index run /dev/tasks/Somar-Search-Task-CreateIndexTask. This task will create the index, set the mapping and create a pipeline for processing attachments.
When the index is created, use SearchIndexJob to index the site content (objects of class Page). You can add additional classes to index via .yml config:
Somar\Search\Job\SearchIndexJob:
IndexedClasses:
- App\Model\DocumentModule rating system helping users find modules that are well supported. For more on how the rating system works visit Module standards
Score not correct? Let us know there is a problem