The admin

One page on your own site, behind a password: the stats, the history and every setting of the chat.

The admin is a page of the chat itself, on your own site: https://your-site/opensolr-chat/admin. The stats, the history of the conversations and every setting of the chat are there, and nothing about it lives anywhere else.

01 · Before the first sign-in

Until an admin password is set, the admin does not open. It shows the command to run instead:

php vendor/bin/opensolr-chat-bot password <data_dir>

<data_dir> is the data_dir of your front controller. Run it in your project folder as the user PHP runs as, then reload the page. See The admin password.

Signing in, sessions and the captcha in front of the admin are on Signing in to the admin.

02 · The tabs
TabWhat you set there
StatsHow the chat is used: messages, visitors, countries, signed-in users, searches, answers with no link, ratings and clicks
HistoryEvery conversation of the last 30 days, filtered and searched, each one whole in its own window
AccountYour Opensolr email and API key, Test connection, and the index the chat answers from
AssistantYour own instructions for the assistant, and its time zone
Chat windowThe title, the text of the chat button, the greeting, the placeholder, your logo and the accent colour
LimitsCharacters per message and per text to translate, questions per visitor, questions per conversation
CaptchaThe reCAPTCHA v2 keys, and how many hours a solved captcha lasts
LanguageThe language of the admin
Add to your pagesThe script tag to paste into your pages, and how to show who is signed in

Stats and History are pages of their own. The other tabs are one form: Save settings at the bottom saves every tab at once, and you stay on the tab you were on. The button is not shown on Add to your pages, which has nothing to save. When something cannot be saved, the admin lists what is wrong at the top and keeps what you typed, except the two secret keys.

03 · The same settings, hosted

The client is the same package Opensolr runs for the hosted chat. In the Control Panel of an index, the hosted chat has the same Assistant, Chat window and Limits tabs, an Embed code tab in place of Account, Captcha and Add to your pages, a Signed-in visitors tab, and its Stats and History. See Chat Bot in the platform documentation.

The admin

The Opensolr Chat Bot Client is open source and MIT licensed. Questions about your Opensolr account, index or plan go to opensolr.com/contact; questions about the client itself belong on GitHub.

Opensolr Chat Bot Documentation