Page tree

Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

The Solr module (full name Magnolia Solr Search Provider Module) allows you to use Apache Solr, a standalone enterprise-grade search server with a REST-like API, for indexing and crawling Magnolia content, especially if you need to manage assets in high volumes (100,000+ DAM assets).

For a brief overview of Solr's main features see the Solr search page. For module compatibility with Apache Solr and module release notes see the Solr module release notes page.

Module structure

The module (parent) consists of five submodules. The first two – Content Indexer and Solr Search Provider – are required for correct functioning of the Solr search feature. 

artifactIDDescription

magnolia-solr-search-provider-parent

Parent reactor.

magnolia-content-indexer

Indexes Magnolia workspaces. It can also crawl a published website.

magnolia-solr-search-provider

Provides templates for displaying Solr search results on a site and faceted search components.

magnolia-solr-workbench

Provides a Solr container for list, search and thumbnail views in content apps.

magnolia-solr-search-provider-bundle

A bundle containing the Content Indexer, Search Provider and Solr Workbench modules, together with third-party libraries and sample Solr configuration files managed-schema and solrconfig.xml.

magnolia-solr-uninstall

For the removal of the old, pre-2.0 version of the Content Indexer module and Solr module configuration.

Version 2.0 of the Solr module didn't support migration from the older version. The older version had to be uninstalled first.

Installing

Maven is the easiest way to install the modules. Add the following dependencies to your bundle:

<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-content-indexer</artifactId>
  <version>5.2.5</version>
</dependency>

<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-search-provider</artifactId>
  <version>5.2.5</version>
</dependency>

<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-workbench</artifactId>
  <version>5.2.5</version>
</dependency>

Pre-built JARs are also available for download. See Installing a module for help.

If you install with JAR files, include the dependent third-party libraries.

Solr Search Provider bundle

The Content Indexer, Search Provider and Solr Workbench submodules are available in a bundle which also contains a sample configuration set and some third-party libraries such as crawler4j or SolrJ:

Configuration

For the installation information about Apache Solr server and for further configuration details see the following pages: