This module is directly supported by opensolr.com. It extends the main Search API Solr module and acts as a layer for connecting and managing solr services using opensolr services.
Requirements and dependencies
The Search API Solr module is a required dependency. The Key module is optional: it has not been a hard dependency since 2.2.0, and since 2.3.0 it is an explicit opt-in, enabled from the module settings, so nothing changes for sites that do not use it.
The module supports Drupal 10.1 and 11.
Installation, documentation & configuration
Start with the Get Started page, reworked in 2.4.0 into a guided four step setup that tracks its own progress and shows you what is already done: create your opensolr account, connect this site to it, create your index and Search API server, then create your Search API index.
You can run this for free
Opensolr has a free plan that is free forever, not a trial with a countdown on it. It gives you a real, dedicated Solr index on managed infrastructure, which is enough to set this module up end to end and to run a small site on it indefinitely. No card, nothing expires.
If you outgrow it: because you found this module on drupal.org, you qualify for the partner discount, 20% off any small or medium plan for a full year, on top of the yearly discount. All that is asked in return is your feedback on the module.
Search API opensolr comes with a configuration page, and a submodule Search API opensolr security that is disabled by default.
The configuration form can be found at: /admin/config/search/search-api/opensolr and it is mandatory to configure it before proceeding with anything else. This is the core of the module functioning well.
Starting version 2.2.1, a new feature called Autoconfigure facilitates the creation of: opensolr core, drupal search api server and automatic upload of config.zip to opensolr with a click of a button.
The optional sub-module helps site builders update the security of their cores without having to navigate to their opensolr account. One can update the core's basic authentication and can add/remove IP restrictions.
Support
Issues are handled in the issue queue. For anything related to the opensolr service itself, see the platform documentation or contact opensolr.
| Attachment | Size |
|---|---|
| configuration system keys | 40.44 KB |
| opensolr add key | 69.32 KB |
| opensolr config form | 44.05 KB |
Project information
- Project categories: Site search
- Ecosystem: Search API Solr
385 sites report using this module
- Created by bbu23 on , updated
Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.
Releases
2.4.0 — The "Get started" tab is now a guided four-step setup page with live status; the in-Drupal account registration wizard (retired API) is removed.








