Install the Extension with Composer

Opensolr Search installs with Composer like any other TYPO3 extension, in a few minutes. New versions then come in with your regular composer update.

Requirements

• TYPO3 13.4 or TYPO3 14, installed with Composer.
• PHP 8.2 or newer, with the cURL, JSON and mbstring extensions.
• An Opensolr account: create one.

Install

1. In the folder of your TYPO3 project, run composer require opensolr/typo3-opensolr-search.
2. Run vendor/bin/typo3 extension:setup, so TYPO3 creates the tables of the extension.
3. Add a cron job on your server that runs every minute: * * * * * cd /path/to/your/project && php vendor/bin/typo3 opensolr:cron. It drives bulk ingestion and keeps the chat bot switch fresh: Ingest All Now.
4. In the TYPO3 backend, open Site Management > Opensolr Search and connect your Opensolr account.

The extension key is opensolr_search. It needs no TypoScript of its own and no changes to your site package: every setting lives in its backend module. The source is on GitHub: https://github.com/phpcip/typo3-opensolr-search.

What the extension adds

• Site Management > Opensolr Search, a backend module for administrators with ten tabs: Settings, Data Crawler, Data Ingestion, Facet Mapping, Search Page, Search Tuning, Analytics, Elevation, Filters and Chat Bot.
• A page named Search at /opensolr-search, hidden from your menus and left out of TYPO3's own indexing, holding the Opensolr Search content element. When a page already sits at that address, the extension uses it. Your search page
• A sitemap at /opensolr-sitemap.xml, for the Data Crawler. The extension sitemap
• Meta tags and structured data in the head of every page. SEO meta tags
• Its own tables in your TYPO3 database: tx_opensolrsearch_settings (your settings), tx_opensolrsearch_queries and tx_opensolrsearch_clicks (the search log), tx_opensolrsearch_elevations (pin and exclude rules), tx_opensolrsearch_ingest_jobs (bulk ingestion), tx_opensolrsearch_query_terms with tx_opensolrsearch_query_words (past searches for suggestions), and two small tables for temporary data and rate limits.
• The console command opensolr:cron, for your cron job.

Remove it

• composer remove opensolr/typo3-opensolr-search removes the extension, its module, the sitemap and the meta tags. Stop the cron job too.
• Its tables stay in your database until you drop them; the database analyzer of the Install Tool offers to remove them. The Search page stays as a normal page; delete it yourself if you no longer need it.
• Your Opensolr Index and its documents stay in your Opensolr account, ready if you install the extension again. To remove the index: Delete an index.