Integrating Solr 4.5 in Enterprise Server 10
Integrating Solr 4.5 in Enterprise Server 10 consists of performing the following steps (listed in the order in which they should be carried out):
Note: It is assumed here that Solr runs within Tomcat.
1. Installing Solr
For information about installing Solr, please refer to the Apache Solr Reference Guide (PDF).
2. Configuring Solr
Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.
For use with Enterprise Server, configure Solr as follows:
Step 1. Edit the <tomcat>/conf/tomcat-users.xml file to:
<xml version='1.0' encoding='utf-8'?> <tomcat-users> <role rolename="manager-gui"/> <role rolename="standard"/> <user username="woodwing" password="ww" roles="standard,manager-gui"/> </tomcat-users>
Note: The user specified in “username” is needed to manage Tomcat; it is not an Enterprise user.
Step 2. Open the Solr configuration file on Enterprise Server:
<Enterprise installation directory>/config/config_solr.php
Step 3. Verify if the correct URL is defined in the SOLR_SERVER_URL setting.
define ('SOLR_SERVER_URL', 'http://localhost:8080/solr');
Step 4. Verify if the correct collection is defined in the SOLR_CORE setting.
define ('SOLR_CORE', 'collection1');
Step 5. (Optional) Define the time-out duration in the SOLR_TIMEOUT setting.
define ('SOLR_TIMEOUT', 5);
Note: Changing this value may be necessary when time-outs occur while indexing many objects. However, usually it is better to adjust the solrconfig.xml file by changing settings such as ramBufferSizeMB, mergeFactor, and autoCommit.
3. Installing the Enterprise Schema
In this step, the default Solr schema file is replaced by the Enterprise version.
Step 1. Unpack the file SolrEnterprise_10.x.x_Buildyz.zip that is delivered together with the Enterprise Server installation.
Step 2. Copy the file named schema.xml to <solr>/<corename>/conf/. Confirm that you want to overwrite the already existing schema.xml file.
Note: The core name is usually 'collection1'.
Step 3. Copy the file named solrconfig.xml to <solr>/<corename>/conf/. Confirm that you want to overwrite the already existing solrconfig.xml file.
Step 4. Do one of the following:
- Restart Tomcat server.
- On the admin page of Solr 4, click Reload for the appropriate collection.
4. Testing the integration
Step 1. In Enterprise Server, access the Server Plug-ins Maintenance page in order to activate the Solr Search plug-in.
In Enterprise Server, click Server Plug-ins in the Maintenance menu or on the Home page.
Step 2. In Enterprise Server, access the Health Check page and run the Solr Search Server test.
Step 2a. In Enterprise Server, click Advanced in the Maintenance menu or on the Home page. A page with all advanced Maintenance features appears.
Step 2b. Click Health Check.
The Health Check page appears.
Step 2c. At the bottom of the page, click Clear All.
Step 2d. Select the test named Solr Search Server.
Step 2e. Click Test.
The test is executed and the result is displayed next to the test. It should display “OK”.
Note: If the test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.
Error when (re-)indexing Solr 4.5: "Operation timed out after 5000 milliseconds with 0 bytes received"
When this error is shown in the log files after (re-)indexing Solr 4.5, increase the value of the SOLR_TIMEOUT setting (for example by doubling it) in the <Enterprise installation directory>/config/config_solr.php file.
- 27 September 2017: Added section 'Troubleshooting'.