The Solr module uses the Apache Solr search platform to index and crawl Magnolia content. Solr is a standalone enterprise search server with a REST like API. Solr uses the Lucene library for full-text indexing and provides faceted search, distributed search and index replication. You can use Solr to index content in an event-based or action-based fashion. The module is compatible with Apache Solr 4.
Installing the Magnolia Solr bundle
The Magnolia Solr bundle consists of three modules:
- Content Indexer indexes Magnolia workspaces. It can also crawl a published website.
- Search Provider provides templates for displaying Solr search results on the site and faceted search components.
- Search Provider Theme provides autocomplete functionality that predicts the search term the user is typing.
See Installing a module on how to install the bundle using JARs or Maven dependencies.
If you install with JAR files, include also the dependent third-party libraries. Without them the Tika parser and suggestions won't work.
Installing Apache Solr
Apache Solr is a standalone search server. You need the server in addition to the Magnolia Solr modules.
Download Apache Solr and extract the zip to your computer:
Starting Apache Solr
Go to the
example directory and start Solr.
This type of startup works for testing and development purposes. For production installation see Taking Solr to Production.
Configuring a schema and request handlers
A schema file specifies what fields the Magnolia content can contain, how those fields are added to the index, and how they are queried. An ExtractingRequestHandler extracts searchable fields from Magnolia pages.
Download the configuration files and overwrite the default files in
Update of Solr Search Provider module into version 2.2
Magnolia Solr Search Provider module changed the API in version 2.2, this was necessary to fix several issues. Full changelog for version 2.2 https://jira.magnolia-cms.com/projects/MGNLEESOLR/versions/16739
Regarding the changes in the module it's recommended completely recreate the Solr indexes after to upgrade to version 2.2.
Refactoring of pagination
Logic of pagination was extracted from
info.magnolia.search.solrsearchprovider.logic.model.page.SolrPager class. Pager can be obtained by
AbstractSearchResultModel#getResult is replaced by
Changes in exception handling when error occurs during communication with Solr server
info.magnolia.search.solrsearchprovider.logic.providers.SolrSearch#getSchemaFields newly throws
java.io.IOException. So the exceptions thrown during communication with Solr server are not swallowed anymore, so client can take appropriate action.
Changes in Solr schema configuration
Indexers now newly requires
workspace Solr schema field. If you are using Indexers you have to add the
workspace filed into your Solr schema configuration and retrigger reindexing by setting
indexed property to false for your Indexers (Indexer configuration).
Indexing Magnolia workspaces
The Content Indexer module is a recursive repository indexer and an event based indexer. You can configure multiple indexers for different sites and document types. The content indexer also allows you to crawl external websites using JSoup and CSS selectors. You then define different field mappings that will be obtained for each node and indexed in the solr index.
Configure an indexer in Configuration >
/modules/content-indexer/config/indexers. Example configurations for indexing a website and DAM assets are provided. Duplicate one of the examples to index another site or workspace.
Indicates whether indexing was done. When Solr finishes indexing content-indexer will set this property to
optional, default is
JCR node type to index. For example, if you were indexing assets in the Magnolia DAM you would set this to
optional, default is
Pull URLs instead of pushing. When
optional , default is
Node in the workspace where indexing starts. Use this property to limit indexing to a particular site branch.
Sets the type of the indexed content such as
Workspace to index.
Field mappings defines how fields in Magnolia content are mapped to Solr fields. Left side is Magnolia, right side is Solr.
You can use the fields available in the schema. If a field does not exist in Solr's schema you can use a dynamic field
The indexer uses an IndexService to handle the indexing of a node. A basic implementation is configured by default:
info.magnolia.search.solrsearchprovider.logic.indexer.BasicSolrIndexService. You can define and configure your own IndexService for specific needs.
Register the IndexService in the Content Indexer module configuration:
Crawling a website
The crawler mechanism uses the Scheduler to crawl a site periodically.
Example: Configuration to crawl bbc.com
When a crawler is enabled
The max depth of a page in terms of distance in clicks from the root page. This should not be too high, ideally 2 or 3 max.
The max number of simultaneous crawler threads that crawl a site. 2 or 3 is enough.
optional, default is every hour
A CRON expression that specifies how often the site will be crawled. CronMaker is a useful tool for building expressions.
Sets the type of the crawled content such as
List of sites to crawl. For each crawler you can define multiple sites to crawl.
Name of the site.
URL of the site.
Field mappings defines how fields parsed from the site pages are mapped to Solr fields. Left side is the crawled site, right side is Solr.
You can use any CSS selector to target an element on the page. For example,
You can also use custom syntax to get content inside attributes. For example, meta keywords are extracted using
Providing a Solr search
The Solr Search Provider module contains templates to display search results on the site. It also provides faceted search components for refining the results further. The faceted search gets related facets from the search context. Suggestions and available fields are available in Freemarker context.
Configuring the Solr server base URL
Configure the Solr server address in Configuration >
/modules/solr-search-provider/config/solrConfig@baseURL. See HttpSolrServer Javadoc for other properties.
Creating a search results page
Create a search results page using the
solrSearchResult page template. To try it in the demo-project, edit the home page properties. and select your Solr results page in the Search Page field.
URL domain filtering
You can filter results by URL domain in the Search Results component dialog.
Field boosting for relevance
The example query
title^100 abstract^0.1 will boost the rank for matches in the
title field 1000 times more than equivalent matches in the
The query will give the following results:
If instead you boost the abstract over the title you would get the following results for the same search. The returned snippets are now primarily from page titles.
Filtering search results
Positive filtering: Return only results where the keyword
conference is present.
Negative filtering: Don't return results where the keyword
conference is present.
You can add more filters by separating them by spaces.
- Faceting on all fields
- Ranged faceting
- Similar search