MAGENTO - APACHE SOLR INTEGRATION

MAGENTO - APACHE SOLR INTEGRATION - PART II (SETUP)

Tue, 03/01/2011 - 18:30

Continuing with the short series about integrating Magento with Apache Solr (started in this post), we'll now see how to set up and put Solr to work together with Magento.

Installing Solr

Integration with Solr has been available since version 1.8 Enterprise of Magento. For now, this is only available for the Enterprise version, not for the Community version.
First thing to do is to download Apache Solr. Grab it from here and extract the file (a typical location - for Linux - would be /usr/local/share/).

Note: to be able to run Solr, you will need Java installed in your server. I'm assuming you already have that. If you don't, just google how to do it, it is everywhere...

Once Solr is downloaded and extracted, we can test if it runs, just go to [solr-path]/example, and type the following in a terminal:

After executing that line, the terminal should start spitting information similar to this:

What's this? This is Solr running inside of Jetty. It comes that way when you download it. You can make it run in other servlets containers (such as Tomcat), but that is outside of the scope of this post. And, hey, Jetty is as cool as Tomcat, okay? :)

This terminal must be kept open while we use Solr. Of course that, in your production environment, you wouldn' t start Solr this way, but will make it automatically available each time the server starts. Take a look here for more info on how to do that.

The last verification to ensure that Solr is running in your machine: go tolocalhost:8983/solr in your browser. You should get this:

Like it says: Welcome!

Configuring Solr for Magento

Great, Solr is working. Now, what do we need to do to make it work with Magento? One of the keys when working with Apache Solr, is defining the right XML config files. The two basic files are:

solrconfig.xml: contains most of the parameters for configuring Solr itself.
schema.xml: contains all of the details about which fields your site is using, how these fields should be added to the index, and how they should be returned for queries.

These files need to configured according to the job we want Solr do to. Fortunately, the Magento team has already prepared them for us. The only thing we need to do is to copy the Solr conf directory from our Magento Enterprise installation (remember, 1.8 or higher), and replace the original Solrconf directory with it.

In Magento, the folder is located in: [magento-instance-root]/lib/Apache/Solr/conf.
In Solr, the folder is located in [Solr-instance-root]/example/solr/conf.

The trick is just to copy the directory from Magento, and replace the one in Solr. That's it! If you look closely, you'll see that the directory contains not just these two files, but also a bunch of other files, most of them called "protwords_??.txt", or "spellings_??.txt" (replace the ?? for two digit languages codes, such as EN, ES, etc). These are files Solr uses to handle searches in specific languages, and allow you to do a lot of fine tuning in your searches. The Magento config, out of the box, comes with the settings to use many different languages with Solr.

After replacing the directory, stop Solr (if it was still running) by clicking CTRL + C in the terminal. Then, start it again (java -jar start.jar). This time, you'll see some new stuff:

Those are all good signs. Solr has got its new configuration, and now it's ready to dialogue with Magento.

Enabling Solr In Magento

Solr is ready, it knows about Magento's dialects and tastes. It is ready and eager to work with Magento, but still Magento isn't aware of Solr's existence! Lets change all that and make them good friends.
That is done in Magento admin site. Go to the System menu, then theConfiguration option. In the options in the left panel, click on Catalog. And finally, in the options that appear in the central panel, choose Catalog Search. You'll get this screen:

Here, we can tell Magento to use Solr, by selecting it in the Search Engine dropdown. Once we do that, the options change to this:

The configuration is very simple. Just provide the right info about Solr's server, port, and (if needed) authentication information. We are running it in the same machine as Magento, that's why we left the default options selected (localhost, port 8983). Running Solr in a dedicated server could be a very good idea if your site has lots of traffic.

Now, let's click on that colorful Test Connection button:

Good stuff! We have now Magento relying on Solr, and Solr ready for Magento. We are just one step away from offering a much better search experience to our customers.

Indexing Magento information in Solr

The data must be sent to Solr so it work its magic. That is very simple! We just need to recreate the Magento indexes in the usual way. Go to System, Index Management, and recreate them.
In the Solr console, you'll see a lot of activity while the reindexing goes, with things like this:

It is not crucial to understand what Solr is saying here, but it is reassuring to see that there is movement. That's the signal that the information is being sent to Solr.
Go and grab a cup of coffee while Magento and Solr share the info.

Checking stuff in the Front End

Now, go to your store page, and start searching using Solr. If your catalog is very large, you should notice the performance improvement right away. And you will also have new features available (assuming you enabled them in the search configuration earlier). For example, this is a screenshot of theSuggestions feature:

Out of the box, you get the following features working with Magento:

The Product search
The Navigation search (if you click "Furniture", Solr can return the products in this category).
The Faceted Search
The Suggestions
Search Recommendations (you can associate terms to another terms. Good for a "You may also like" feature for your customers).

Oddly, it seems that the search autocomplete is not going through Solr. I guess the Magento team could not implement that on time, but I imagine that will be coming in the near future (can anyone on the Magento team confirm this?)

Hoping this has been helpful!

Coming up in this series, we'll publish how to index custom information in Solr from Magento, and how to create an Ajax UI to allow the users to search that info. Stay tuned!

aldo

Managing Partner

Aldo works as a general mentor for the development teams, keeping in direct contact with programming and design.