Three things: a PHP site on a server you control, an Opensolr Index with your site’s data in it, and the AI requests of your Opensolr plan.
With the extensions pdo_sqlite, curl, json and mbstring. Most PHP installations have all four; php -m lists the ones yours has.
The client is installed and updated with Composer, from Packagist.
Apache with mod_rewrite and .htaccess allowed in that folder (the package ships the .htaccess), or nginx with a location block. Both are on Installing. The answers are streamed, so nothing between PHP and the browser may hold them back: see Streaming.
Writable by the user PHP runs as. The client keeps one SQLite database there, with its settings, its counters and the admin password hash, and your logo if you upload one.
Your server must be able to open outbound HTTPS connections to Opensolr and, when the captcha is on, to Google, where a solved captcha is checked.
Recommended. On HTTPS the cookies of the chat and of its admin are marked Secure.
That is the whole list: no MySQL, no framework, no separate virtual host, no Node.js and no build step.
- An Opensolr account. Create one if you do not have one yet.
- An Opensolr Index with your site’s data in it, the same index the hosted chat would use: see What the chat bot needs. Your data gets there by crawling your site or by pushing your data. The chat answers from that index and from nothing else.
- AI requests. Every answer uses the AI requests of your Opensolr plan. Every package includes AI, with 500 AI requests a month; how many are used is on API Quota, and bigger allowances are on opensolr.com/pricing.
- An API key, preferably a scoped key made only for the chat. See Account and index.
Any current browser on a computer, a tablet or a phone. A browser too old for the chat simply shows no chat button, and your page works exactly as before.
The chat keeps the conversation in the browser’s own storage, and, with the captcha on, remembers a solved captcha in a cookie. A visitor who blocks cookies for your site cannot get past the captcha; the chat tells them to allow cookies for your site.
The same chat runs on Opensolr’s side, with nothing to install: Put the chat on your site. On Drupal, the Opensolr Search module has it built in: Drupal: Opensolr Search module.
Start here
- Documentation home
- Requirements