Account Setup
After installing the module, you need to connect it to your Opensolr account. This creates a search index and configures everything automatically.
What you need
- Your Opensolr email — the email you registered with at opensolr.com
- Your API key — find it in your Opensolr Dashboard under Account Settings
Step-by-step setup
- Go to Configuration > Search > Opensolr Search (
/admin/config/search/opensolr) - Enter your Opensolr email and API key in the Opensolr Account section
- Select a Region from the dropdown — pick the one closest to your server for best performance
- Click "Save & Connect"
What happens when you click "Save & Connect"
The module runs through an automatic setup process with a progress dialog:
- Step 1 — Validates your credentials with the Opensolr API
- Step 2 — Creates a new search index (named
drupal_XXXXXXXX__dense) in your selected region - Step 3 — Downloads and uploads the correct Solr configuration for the web crawler
- Step 4 — Reloads the Solr core and verifies it's working
- Step 5 — Enables Query Elevation (lets you pin/exclude results later)
You don't need to create indexes manually, upload config files, or configure Solr. The module handles everything.
Choosing a region
The region dropdown shows all available Opensolr clusters with country flags. Pick the region closest to your web server (not your users) for the lowest latency between Drupal and Solr.
The dropdown is populated directly from the Opensolr API based on your account plan. Pick the region that works best for you. Need a dedicated web crawler server in your own region? Contact us — we can deploy one wherever you need it.
Opensolr Plan card
After connecting, the Settings page shows your Opensolr Plan card with:
- Plan name and usage limits
- Documents indexed — how many pages are in your search index
- Storage used — disk space consumed on the Solr cluster
- Crawled pages — progress bar showing crawler activity vs. your plan limit
Reconfiguring your index
If you need to switch regions or start fresh:
- Click the "Reconfigure Index" button in the Opensolr Account section
- Select a new region
- Click "Save & Connect" again
The old auto-created index is deleted automatically to free up your plan slot. Your search will be empty until the crawler re-indexes your content.
Reconfiguring deletes the existing auto-created index and all its data. Only indexes created by the module (named drupal_*__dense) are deleted — indexes you created manually in the Opensolr dashboard are never touched.
Next step
Once connected, head to Content Types to choose what the crawler should index.