Solr module

Edition

DX Core

License

MLA

Issues

MGNLEESOLR

Maven site

Solr

Latest

5.6

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.

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.

ArtifactID Description

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:

  • Classes for indexing into Solr.

  • Templates (including faceted search components) for displaying Solr search results on a site.

    The templates are based on a deprecated model architecture.

     magnolia-solr-templating

Provides solrfn templating functions for creating a search page based on results from Solr.

     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-ui

Provides support for 6 UI fields.

     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 with Maven

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

<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-content-indexer</artifactId>
  <version>5.6</version>
</dependency>
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-search-provider</artifactId>
  <version>5.6</version>
</dependency>
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-templating</artifactId>
  <version>5.6</version>
</dependency>
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-workbench</artifactId>
  <version>5.6</version>
</dependency>
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-ui</artifactId>
  <version>5.6</version>
</dependency>

Magnolia Core Compatibility module (artifact ID: magnolia-core-compatibility) is required, if you intend to use the Solr module in a version below 5.2.3. In this version, released with Magnolia 6.2.1, we removed dependencies on the old Content API.

Solr Search Provider bundle

The Content Indexer, Search Provider, Solr Templating, Solr Workbench and Solr UI 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:

Related topics
Feedback