Configure Extension

After Install EXT:solr you need to configure the extension. Only a few steps from below are necessary for Index the first time.

Extension Configuration

Underlying settings can be found in the extension configuration, though the default settings are appropriate for most sites you should check and adapt this settings if necessary:

../_images/typo3-extension-manager.png

Static TypoScript

The extension already comes with basic TypoScript configuration that will work for small pages out of the box. For now create or edit an existing TypoScript Template record in your page tree and add the provided static TypoScript:

../_images/typo3-include-static-typoscript.png

Search Markers

EXT:solr is indexing everything on a page between <!– TYPO3SEARCH_begin –> and <!– TYPO3SEARCH_end –> to ensure this is the case, check the output of you website and add the markers to your template.

If the markers are missing, you should add them to your template. To increase the quality of the search results the markes should only wrap the relevant content of a page and exclude e.g. menus, because they are same on each page. The markers can be used multiple times, but make sure each “TYPO3SEARCH_begin” is properly closed with “TYPO3SEARCH_end”.

The most simple configuration for my page was:

page.10 {
    stdWrap.dataWrap = <!--TYPO3SEARCH_begin-->|<!--TYPO3SEARCH_end-->
}

Enable indexing

Indexing wil only work if you allow content to be indexed by stating so in your TypoScript setup configuration:

config {
    index_enable = 1
}

Site Handling

In TYPO3 9.5 the new backend module called “Sites” was introduced. This Module can be used to setup and configure the Apache Solr connections.

Tip

Please refer to official TYPO3 docs about site handling, to setup your first site configuration.

Warning

EXT:Solr needs a proper domain as base for the site. If the base is set to “/” or a similar relative path, the Indexing will throw an error, so please make sure that “base” is a fully qualified domain like “https://my.project.tld/”

Configure Solr Connections

Important

The Site-Handling GUI provides the common setup scenario for most users only. There is no possibility in the GUI to setup different things for each language in site configuration except Corename(core path).

Tip

All in sites config.yaml global defined thing for EXT:solr can be configured for each language differently by editing this file manually.

As first step the authority part of URI to Apache Solr machine must be configured.

../_images/Site_handling_Setup_solr_01.png

The Corename(aka path to core) for each available language must be assigned respectively.

../_images/Site_handling_Setup_solr_02.jpg