DEPRECATION WARNING

This documentation is not using the current rendering mechanism and will be deleted by December 31st, 2020. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

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.

Static TypoScript

The extension already comes with basic 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

Update the constants to match the current setup:

plugin {
    tx_solr {
        solr {
            read {
                host = 192.168.99.100
                port = 8983
            }
            write < .read
        }
    }
}

Adjust the host according to where your Solr is reachable, see Solr.

Note:

The static template configures what you need to query the solr server and do the indexing. In most projects you want to add facets or custom styles. If you want to use the default style you need to add the template “Search - Default Stylesheets”. Beside that EXT:solr provides a few example typoscript templates that should help you to build your own configuration.

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 most simple configuration for my page was:

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

Domain Records and Indexing

To enable Solr connections, the extension needs a Domain Record and indexing has to be enabled. Therefore enable indexing by setting the following TypoScript:

config {
    index_enable = 1
}

Also define that your root page is actually a root page:

../_images/typo3-root-page.png

Last but not least, add the domain record to the root page:

../_images/typo3-domain-record.png

Initialize Solr Connection

Next, initialize the Solr Connection from TYPO3 and check whether everything works as expected.

To initialize the connection, open the Cache-Menu and start Initialization.

../_images/typo3-initialize-connections1.png

Check whether connections to Solr could be established by opening the Reports module and go to Status Report view:

../_images/typo3-check-connections.png

That’s it, head over to Index the first time.