Welcome!
The Opensolr Chat Bot Client puts an out-of-the-box chat bot on your website that talks to your site’s data: it answers your visitors from your own Opensolr Index, with every page it uses linked. It is free and open source under the MIT license, and it runs on your own server.
The chat button at the bottom right of this page is the Opensolr Chat Bot, answering from the Opensolr Index of opensolr.com.
The client is the same package Opensolr runs for the hosted chat, with the same settings, stats and history. Pick the way that fits your site:
- Hosted by Opensolr. Nothing to install: list your domains and paste one line. See Put the chat on your site.
- Self-hosted, on your own server. This documentation: the chat, its admin and its data stay on your server.
- On Drupal and WordPress. The Opensolr Search module and plugin show the hosted chat on every page of the site with one switch. See The ways to have the chat bot.
How the three compare: Three ways to have your chat bot.
- Answers from your site, written word by word, in each visitor’s own language, with every page, product and PDF page linked. See What your visitors get.
- Commands that answer at once:
/search,/time,/rate,/vat,/translateand more. See Commands. - Stats and History in your admin: what people ask, from where, what your index could not answer, and every conversation of the last 30 days.
Your visitors talk only to your site. Your site keeps your Opensolr email and API key, asks Opensolr for each answer, and passes it on to the visitor as it is written.
The client is a small PHP package with no framework and no MySQL. It answers on one path of your own site, /opensolr-chat by default, and keeps its settings in a SQLite database in a folder of your choice. Your pages get one script tag.
- Check the requirements: PHP 8.1 or newer, and an Opensolr Index with your site’s data in it.
- Install it with Composer and mount it on one path of your site.
- Set the admin password, sign in, connect your account and choose the index.
- Add one script tag to your pages.
- github.com/phpcip/opensolr-chat-bot-client: the source code and the issues.
- packagist.org/packages/opensolr/chat-bot-client: the Composer package and its versions.
- opensolr.com/opensolr-chat-bot: the product overview.
- Enterprise Site Search, all in one: how your site’s data gets into your Opensolr Index, and everything it can do there.
- Chat Bot in the platform documentation: the hosted chat, run by Opensolr.