Last updated 11 August 2017. Created on 20 May 2013.
Edited by nerdcore, minorscience, drunken monkey, jiv_e. Log in to edit this page.

For using the Search API Solr Search module, you first need a Solr server with the appropriate configuration files. For that, you have two options: either installing Solr on your own server, or purchasing a server instance at a Solr hosting provider.

The most important thing to remember, for both variants, is to configure the Solr server with the correct configuration files. See the section in the relevant version for your setup:

Using a hosted solution

Using a hosted solution has the big advantage of requiring no expertise in Solr. There are a number of Solr hosts which either support the Search API directly or allow you to upload your own configuration files. A few of them are listed on the Search API Solr Search project page, but the list is surely incomplete (and might also be out-dated). One thing to watch out for (except for either explicit support of the latest version of Search API Solr Search or support of uploading custom configs) is that the connection shouldn't require any advanced authentication mechanism, like a certificate or appending GET parameters to all requests, as this currently isn't supported by the module (out of the box). Currently, only Basic HTTP Authentication and HTTPS are supported.

And again: remember to use the correct configuration files!
Then, just enter the connection information for Solr (which you should have received from the Solr host) when creating the Search API server and you should be good to go.

Installing Solr manually

While Solr is simply available through the package manager in most popular Linux distributions, the versions in the distribution repositories are usually very out-dated (e.g., the latest Ubuntu LTS version, 14.04, contains Solr 3.6). Also, installing and running Solr manually isn't very hard, so doing that is usually the better choice.

The Search API Solr Search module will work with Solr version 3.5 or any higher one (e.g., 3.6, 4.0, 4.8, 5.1). The config files to use are contained in the module's solr-conf/ directory, grouped by the major version number of Solr (3.x, 4.x, 5.x). If the major version you want to use is not contained there, the version will not be supported by the module (e.g., it's possible 3.x support will be dropped at some point, while 1.4 support was already dropped).
If you are using one of the numerous great guides on the internet for setting up Solr, simply remember to use these config files and the integration with Search API should work as expected.

Detailed instructions on setting up Solr depend on the major version used, and can be found here:

It is usually recommended to use the latest stable version available, since those will offer the best performance and most features (some of which will also be supported by this module). However, new major versions ("x.0", "x.1") often also contain regressions, so be careful when using one that was only released recently and maybe search for existing issues with it.

Note: Due to such an incompatible change, Solr versions 5.5 and higher (in the 5.x) branch are not supported. Please use either Solr 5.4.1 or Solr 6.x (once it's supported by this module).

Installing Solr with Ansible

Ansible is a simple server automation tool. For installing fully functional Apache Solr server instance you can try an Ansible script maintained by jiv_e. It does a lot of stuff including search_api_solr config files placement. See

You can contribute to the project by submitting bug reports, code and documentation! Please help to make it better so no one needs to install Solr by hand.

Looking for support? Visit the forums, or join #drupal-support in IRC.


asauterChicago’s picture

If the host has Solr configured for you, most likely they have Solr configured as a service. So java -jar start.jar will only make someone very confused when it doesn't work. The most likely correct command when running on a host would be: sv restart solr .

jackbravo’s picture

The comment about the instructions not working for solr 4.3+ doesn't seem to be true anymore. And the INSTALL file in the search_api module doesn't mention it. Should we remove it?

SKAUGHT’s picture

the Dev line currently has this updated.

pinkonomy’s picture

How is this possible to run Jetty automatically when starting/restarting Apache?
I am using ubuntu 14.04

drunken monkey’s picture

Please use the issue queue for such questions, since they will often go unnoticed as handbook comments (since it's, as far as I know, not possible to subscribe to those).