Connect Your Opensolr Account

Connect Your Account

Two steps on the Settings tab: save your Opensolr credentials, then create a new Opensolr Index or attach one you already have. The module configures the index for you.

1. Opensolr Account

1. In your Opensolr account, open Account › API Keys and copy your API key.
2. On the Settings tab, enter your Opensolr Email and the API Key.
3. Click Save Credentials. The module checks them with Opensolr and saves them; your index is not touched.

To change them later, click Reconfigure Credentials. The saved API key is never shown again.

2. Search Index

Pick one of the two options.

Create a new index

1. Choose Create a new index and a Region: the regions on offer come from your Opensolr account. The one closest to your web server is the fastest.
2. Click Create New Index and confirm.
3. A progress window runs the steps: Creating Search Index, Configuring Index, Verifying & Registering Sitemap, Enabling Query Elevation, Done!

The new index starts empty: fill it with the Data Crawler or Data Ingestion. Your previous index is not deleted; it stays in your Opensolr account.

Use an existing index

1. Choose Use an existing index and type in the box to find one of your indexes.
2. Tick what you want done first, or nothing:
   • Reset index: erases all data in the index.
   • Re-configure index (recommended): applies the Opensolr configuration this module needs. Leave it unticked if the index already has it, or if you manage your own schema.
3. Click Save Settings. The module runs what you ticked, then verifies the index, registers your sitemap and enables Query Elevation.

3. Opensolr Plan

Below, the Opensolr Plan section shows your plan and what it allows: Disk Space, Bandwidth, Crawled Pages and Crawl Traffic used against their limits, Max Threads and Max File Size for the crawl, your API calls in the Last Minute and Last Hour, whether the plan has Web Crawler, Analytics and Backup, and an Upgrade / Downgrade button that opens the plans.