Solr module

Search and discovery Unbundled: Extension

Edition

DX Core

License

MLA

Issues

Maven site

Latest

9.0.0

See here for module to Solr compatibility.

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 connecting into Solr.

  • Classes for Solr indexing.

     magnolia-solr-templating

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

     magnolia-solr-workbench-compatibility

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

Compatible with the old Magnolia 5 UI only.

     magnolia-solr-ui

Provides support for 6 UI fields.

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>9.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-search-provider</artifactId>
  <version>9.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-templating</artifactId>
  <version>9.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-ui</artifactId>
  <version>9.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.solr</groupId>
  <artifactId>magnolia-solr-workbench-compatibility</artifactId>
  <version>9.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
Install magnolia-solr-workbench-compatibility only when you have a legacy app built on the old Magnolia 5 UI.

Configuration

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

Related topics
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules