The Account tab connects the chat to your Opensolr account and chooses the Opensolr Index it answers from.
Your master API key can do everything on your Opensolr account. The chat needs far less, so give it a key of its own: a scoped key, made in your Opensolr control panel on the API Keys page.
- Name it after the site, for example Chat bot on example.com, so you know later what it is for.
- Limit it to the index the chat answers from.
- Allow only what the chat uses: searching and answering on that index, the lookups of the commands, and listing your indexes, which Test connection needs.
If that key ever leaks, it can do only that, on that index, and you revoke it without touching anything else. How master and scoped keys differ is explained in Master API Key vs Scoped API Keys.
The email address of your Opensolr account.
The scoped key, or your master API key. Once saved it is never shown again: the field shows dots and the hint Saved. Leave empty to keep it. To change it, paste the new key and test the connection again.
Test connection tries the email and the key, saves them when they work and lists the indexes of the account. What it can answer:
The account works and is saved: 3 indexes. Choose the index and save the settings.
Everything is right. Choose the index below and click Save settings.
The account works and is saved, but it has no index yet.
Create an index in your Opensolr account, fill it with the Web Crawler or Data Ingestion, then test again.
The email or the API key is not right.
Check both, and that the key has not been revoked.
This API key may not list the indexes …
The key is a scoped key that is not allowed to list your indexes. Allow that in the key’s settings on the API Keys page, then test again.
The connection failed: …
Your server could not reach Opensolr. The reason follows the colon; most often a firewall or an outbound proxy blocks HTTPS from the server. See Requirements.
After a successful test, the Opensolr Index list holds the indexes of the account. Choose the one with your site in it and click Save settings. Until an index is chosen and saved, the chat tells visitors This chat is not set up yet.
Changing the email or the API key clears the choice, because another account has other indexes: the admin says Saved. The account changed: test the connection, then choose the index.
- In the SQLite database in your data folder, on your own server.
- Never in the visitors’ browsers: the chat window receives its texts, its colours and its limits, never your email or your key.
- Only your server talks to Opensolr. Your visitors talk only to your site.
To cut the chat off from your account at once, revoke its scoped key on the API Keys page.