Drupal Search API Opensolr

Drupal

Search API Opensolr is a free Drupal module for sites that use Search API and Views. It adds a Search API Solr connector that reads the connection of your Opensolr Index from your Opensolr account, so your Search API indexes, Views and processors stay as they are.

01 · Install

composer require drupal/search_api_opensolr
drush en search_api_opensolr

It needs Drupal 10.1 or 11 and brings Search API Solr with it.

02 · Connect your Opensolr account

Open /admin/config/search/search-api/opensolr, enter your Opensolr Email and, in Secret key, your API key (Account › API Keys in the Control Panel), and click Test connection. With the Key module installed, the API key can be kept there instead. The Get started page, /admin/config/search/search-api/opensolr/get-started, ticks off each step as you go.

03 · Autoconfigure

1

Open Autoconfigure

/admin/config/search/search-api/opensolr/autoconfigure lists the Solr environments of your account, with their Solr version, region and country.

2

Pick one and click Start

The module creates an Opensolr Index, creates a Search API server connected to it and uploads the Search API Solr configuration to the index.

3

Add a Search API index

Add an index on the new server, choose your content and fields, and index.

04 · Or add the server yourself

Under Search API, click Add server, choose the Solr backend and the Solr Connector Opensolr with Basic Auth (recommended), then pick your index from the list. The connection is filled in from your account, and the configuration is uploaded to the index when you save. For an index of a cluster, upload it yourself on the Import Config Zip tab of the server.

05 · Security submodule

drush en search_api_opensolr_security

It adds an Opensolr Security tab to the server: change the HTTP Authentication username and password of your index, and add or remove IP restrictions, without leaving Drupal.

06 · Video

Autoconfigure, from an empty site to a connected Search API server.

07 · Related

Big Search API sites index in parallel from Drush with the Opensolr Turbo Indexer.

Without this module: Drupal Configuration Steps.

Connection problems: Opensolr Connection Issues.

All the ways to connect Drupal: Drupal Setup with Opensolr.