The Settings tab connects the extension to your Opensolr account and to one Opensolr Index, the place where your site's content is stored and searched.
Before you start
- Your Opensolr registration email and your API key. The key is under Account > API Keys in your Opensolr Control Panel: API keys.
- Two ways to get an index. Save & Connect uses an index the extension created before, or creates a new one when your plan has room for it. This is all a new Opensolr account needs: the extension creates its own index. Use an existing index attaches the extension to an index you already have: Use an existing index.
Connect with Save & Connect
- In the TYPO3 backend, open Site Management > Opensolr Search, tab Settings.
- Enter your Email and API Key.
- Click Save & Connect. A window shows each step: Authenticating, Creating Search Index, Uploading Webcrawler Configuration, Reloading Solr Core, Enabling Query Elevation, Done.
- When it says Connected!, click Continue.
What Save & Connect does
- Checks your email and API key.
- When the site has no index yet, it uses an index of your account whose name starts with
typo3_and ends with__dense, the kind the extension creates. When there is none, it creates one with a name liketypo3_1a2b3c4d__dense, in the region of an index you already have when that region has site search, otherwise in the Opensolr region with site search nearest to your site, then uploads the Opensolr site search configuration, reloads the index and switches Query Elevation on. - Creates your Search page at
/opensolr-searchwhen it does not exist yet: Your search page. - Adds your sitemap,
https://your-site/opensolr-sitemap.xml, to the crawl list of the index, when your site address starts withhttps://. The request is signed with your API key, so no verification file is needed. - When the site already has an index, it only saves your credentials and adds the sitemap again: "Saves your credentials without touching the existing search index."
When your plan has no room for another index, the window says "Your current plan allows N search index(es). Upgrade your plan to create more." with an Upgrade Now link to https://opensolr.com/pricing.
After connecting
The tab shows Credentials verified, the Connected Index (a link to it in your Opensolr Control Panel) and the button Reconfigure Opensolr Index and Credentials, which opens the form again to change your credentials, pick another index or start fresh.
Account Summary
- Your plan, with its price or "free forever".
- Disk Space and Bandwidth used, against your plan.
- Crawled Pages and Crawl Traffic, against the crawl limits of your plan.
- Max Threads, Max File Size, the Solr version, the index name and the Crawler IP.
- Last Minute API and Last Hour API: your API requests against your limits.
- Whether your plan includes the Web Crawler, Analytics and Backup.
- Upgrade / Downgrade, a link to https://opensolr.com/pricing.
Pages of this tab
- Use an existing index: attach the extension to an index you already have.
- Save & Start Fresh: replace your index with a new, empty one. It deletes the current index.