Complete Guide to the Opensolr Search Drupal Module

Drupal

Opensolr Search is a free Drupal module that puts your site in an Opensolr Index and gives you a finished search page. This page is the map of the module: each part in a line or two, linked to its page in the Drupal docs.

01 · Get it running

1

Install

composer require drupal/opensolr_search, then enable the module. Drupal 10.1 or newer, 11 or 12, and PHP 8.1 or newer; no Search API needed. Installation.

2

Connect

On the Settings tab, save your Opensolr email and API key, then create a new index or use one you have. Connect your account.

3

Fill the index

The Data Crawler reads your pages; Data Ingestion sends them from Drupal. Which one to use, Data Crawler, Data Ingestion.

4

Search

Your search page is live at /opensolr-search, and Drupal's own search forms send visitors there. Your search page.

02 · Make it yours

TabWhat it does
Facet MappingMaps your Drupal fields to the index and turns them into facets: Facet Configuration, examples.
Search PageSuggestions as visitors type, sorting, Fresh, AI Hints and AI Reader, documents, search by image.
Search TuningHow the words people type and what they mean are weighed.
ElevationPins or hides results for a search.
FiltersLimits every search to the content you choose.
AnalyticsWhat visitors search for and click.

Several languages: Multilingual search. Category trees: Hierarchical categories.

Meta tags and the sitemap the module adds to your pages: SEO.

03 · AI on the same index

The second part of the module, Opensolr AI Search (Drupal 10.5 or newer, with the Drupal AI module), adds the AI Search tab, which makes your index the search of Drupal AI Search, and the Chat Bot tab, which opens the Chat Bot of your index in the Opensolr Control Panel. The chat bot is not part of the module: Opensolr runs it, and one switch there shows it on every page of your site: Drupal AI Search, Chat Bot.

Every plan includes 500 AI requests a month for search by meaning, AI Hints, AI Reader and the chat bot: plans and API Quota.

04 · Coming from Search API Solr

How the two compare and how to switch without downtime.

The module on drupal.org. See it at work on the Drupal demo site.