Drupal Setup with Opensolr

Drupal + Opensolr Setup

Drupal with Opensolr gives you enterprise-grade search — instant full-text results, faceted navigation, autocomplete, and relevance scoring — without running your own Solr server. There are two ways to connect:

Option 1: Search API Opensolr (Recommended)

The easiest path. The Search API Opensolr module includes AutoConfiguration — it creates your Opensolr Index, uploads config files, and sets up the Drupal search server automatically.

Install

composer require 'drupal/search_api_opensolr:^2.2'

AutoConfigure

1. Enable the module in Drupal
2. Go to the module's configuration page
3. Click AutoConfigure
4. Done — your Solr server is created, configured, and ready to index

No need to manually download config files, match Solr versions, or upload zip archives. The module handles everything.

Option 2: Search API Solr (Manual Setup)

If you prefer full control, use the standard Search API Solr module with manual Opensolr configuration.

Step 1: Choose the Correct Solr Version

When downloading config files from the Search API Solr module, make sure the Solr version matches what your Opensolr Index runs. Mismatched versions can cause schema errors or data loss.

Check your Solr version in the Opensolr Index Control Panel dashboard.

Step 2: Configure HTTP Authentication

All Opensolr Indexes are protected by HTTP Basic Auth. In your Drupal Solr server settings:

1. Select Basic Auth as the authentication method
2. Enter your Opensolr username and password
3. Keep credentials simple — avoid special characters that Drupal may not encode correctly

You can view and change your credentials in the Security tab of your Opensolr Index Control Panel.

Step 3: Upload Solr Config Files

1. In Drupal, go to your Search API Solr server settings
2. Download the Solr config zip for your Solr version
3. Upload the zip to your Opensolr Index via the Config Files Editor in the control panel
4. Click Reload to apply

Step 4: Create Your Index and Start Indexing

1. Create a Search API index in Drupal
2. Select which content types, fields, and processors to use
3. Click Index now to start sending content to Solr

Important Notes

• Always use Basic Auth — Opensolr Indexes require authentication. See our HTTP Auth guide for default credentials.
• Keep passwords simple — no special characters in username or password. Drupal's URL encoding can cause connection failures with complex passwords.
• Version compatibility — if your Drupal module expects Solr 9.x but Opensolr runs 8.x, contact us. We can adapt your config files to work on any Solr version without impacting functionality.

Quick Checklist

• Easiest path: Install Search API Opensolr and use AutoConfigure
• Manual path: Install Search API Solr, download config zip, upload to Opensolr
• Always configure Basic Auth credentials in Drupal's Solr server settings
• Match the Solr version when downloading config files
• Keep credentials simple (no special characters)
• Reload your Opensolr Index after uploading config files

Need help connecting Drupal to Opensolr? Reach out to us at support@opensolr.com — we set up Drupal integrations daily and can do it for you, free of charge.