TYPO3 Indexed Search: Setup, Configuration and Crawler Guide

Welcome to the TYPO3 search series! In part 1 you set up TYPO3 Indexed Search in v13 and v14, add a search box, schedule indexing with the Crawler extension and compare Indexed Search with six other TYPO3 search solutions.

Search feature! One of the underestimated useful components to improve the experience of your website’s visitors. In my opinion, at least medium to large TYPO3 websites should have a search feature.

TYPO3 Indexed Search: Setup, Configuration and Crawler Guide

TYPO3’s Indexed Search is a powerful built-in feature that makes it easy for users to find relevant content on your website. With just a few lines of TypoScript, you can customize and extend the search experience, from designing the form to delivering optimized results. In this post, part 1 of our TYPO3 search series, we install and configure Indexed Search in TYPO3 v13 and v14, build a current TypoScript search box, schedule indexing with the Crawler extension, fix the most common problems and compare Indexed Search with six other TYPO3 search solutions.

Short answer: TYPO3 Indexed Search (extension key indexed_search) is the search engine that ships with the TYPO3 Core. Install it with composer require typo3/cms-indexed-search, add the site set “Indexed Search” to your site, place the “Indexed Search” plugin on a search page and let cached pages fill the index. Add the Crawler extension for scheduled re-indexing.

Key takeaways

  • Indexed Search is part of the TYPO3 Core but is not installed by default (TYPO3 documentation).
  • Since TYPO3 13.3, the site set typo3/indexed-search provides the defaults. The results page (indexedsearch.targetPid) and the template paths are set in the Settings editor.
  • Only cacheable pages are indexed. Pages with disabled cache never appear in the results.
  • The classic search box snippet with switchableControllerActions no longer works, because that option was removed in TYPO3 12.0. Use the EXTBASEPLUGIN content object instead.
  • For faceted search or very large sites, ke_search, Apache Solr for TYPO3 or an Elasticsearch-based extension is usually the better fit (see the comparison below).

Tested with / valid for: TYPO3 v13.4 LTS and v14 (14.3 LTS). Updated: November 2026.

How do you install and set up TYPO3 Indexed Search?

Install the package, add the site set, place the plugin and make sure your pages are cached. These steps apply to TYPO3 v13.4 and v14.3 in Composer mode.

  1. Install the extension. Run composer require typo3/cms-indexed-search. In a non-Composer installation the extension is already shipped; activate it in the Extensions module.
  2. Add the site set. Add typo3/indexed-search to the dependencies of your site configuration (config/sites/<site>/config.yaml) or of your site package set. It loads the default TypoScript, which sets config.index_enable = 1 (site set documentation).
  3. Create the search page. Create a page such as “Search” and insert the “Indexed Search” plugin. Select this page as indexedsearch.targetPid in the Settings editor, so that search forms on other pages send visitors to it.
  4. Build the first index. Pages are indexed when they are rendered and stored in the page cache. Open a few pages in the frontend, then check the Indexing backend module.
  5. Exclude pages from the results. In the page properties, tab Behaviour, switch off “Include in Search” for pages such as the sitemap or the search page itself.

How do you re-index automatically with the Crawler extension?

Frontend indexing only covers pages that someone has visited. For complete, scheduled indexing, Indexed Search relies on the Crawler extension (tomasnorre/crawler). Crawler 13.0 supports TYPO3 13.4 and 14.3 (Packagist).

  1. Run composer require tomasnorre/crawler.
  2. In the extension configuration of Indexed Search, enable “Disable Indexing in Frontend” so that only the crawler builds the index.
  3. Create a crawler configuration record in the site root and enable the processing instruction “Re-Indexing [tx_indexedsearch_reindex]”.
  4. Test it on the command line: vendor/bin/typo3 crawler:buildQueue 1 crawl-mysite --depth 2 --mode exec (1 is the uid of the root page, crawl-mysite the name of the configuration).
  5. Add two scheduler tasks of the class “Execute console commands”: crawler:buildQueue once per night and crawler:processQueue every few minutes.

Source: Crawler documentation, Indexed Search use case. Indexing configurations of the types “Page tree”, “Database Records” (for example news), “External URL” and “Filepath on server” are also processed by the crawler (Indexing Configurations).

Which settings matter for PDFs, ranking and languages?

  • Files: Indexed Search indexes files such as PDF, Word, HTML and plain text that are linked from an indexed page and stored in a FAL storage. A file is only indexed or updated when a page linking to it is re-indexed (External media).
  • PDF tools: PDFs need pdftotext and pdfinfo on the server. Their directory is the extension setting “pdftools” (default /usr/bin/).
  • Limits: “maxExternalFiles” caps the number of files indexed per page (default 5), and “minAge” sets the minimum number of hours before a page is indexed again (default 24).
  • Ranking: with the default sort order, words found in the page title, keywords or description rank higher than words in the body text (index_words, index_rel). Good page titles and meta descriptions therefore also improve your internal search.
  • Languages: every language version of a page is indexed as its own entry, and the plugin searches in the current site language.

1. How do you add a search box with TypoScript in TYPO3 v13 and v14?

Use the EXTBASEPLUGIN content object, available since TYPO3 12.3, to render the Indexed Search form anywhere in your layout (changelog). This snippet works in TYPO3 v13.4 and v14.3:

# TYPO3 v13.4 and v14.3: search box for the header or sidebar
lib.searchBox = EXTBASEPLUGIN
lib.searchBox {
    extensionName = IndexedSearch
    pluginName = Pi2
    settings {
        # uid of the page with the Indexed Search plugin (results page)
        targetPid = 62
        displayAdvancedSearchLink = 0
    }
}

At a glance, this configuration renders TYPO3’s Indexed Search plugin as a compact search box. Here’s a quick rundown of each part:

  • EXTBASEPLUGIN: The content object for Extbase plugins. It replaces the older USER object with userFunc = TYPO3\CMS\Extbase\Core\Bootstrap->run, which still works but is no longer recommended.
  • extensionName / pluginName: Specify you’re using the IndexedSearch extension, plugin Pi2. The plugin starts with the form action and shows the results with the search action, so no action configuration is needed.
  • settings: Values here override plugin.tx_indexedsearch.settings for this box only. targetPid sends the form to your results page, and displayAdvancedSearchLink = 0 hides the “Advanced search” link.

Upgrading an older snippet? Remove vendorName, switchableControllerActions (deprecated in TYPO3 10.3 and removed in 12.0, see Deprecation #89463), features.requireCHashArgumentForActionArguments (removed in TYPO3 11.0) and isSearchBox, which the current plugin does not read.

2. Best Practices When Customizing Indexed Search

Keep configuration in files, keep caching intact and test with real content. These practices apply to TYPO3 v13 and v14.

  1. Keep Your TypoScript Organized
    Store your TypoScript in a dedicated file (e.g., setup.typoscript) in your site package. This keeps your configuration modular, making it easier to maintain and debug as your site grows.
  2. Use Namespaced Overrides
    If you’re overriding templates, partials, or layouts, follow a clear, well-structured namespacing convention. This helps you quickly identify your customizations and prevents conflicts with core or third-party code.
  3. Keep cHash Protection Enabled
    The old option requireCHashArgumentForActionArguments = 0 was removed in TYPO3 11.0 and has no effect in v13 or v14. cHash is there to ensure proper caching and prevent unintended URL manipulations, so do not try to work around it; the search form sends its data by POST.
  4. Test in Multiple Environments
    Because Indexed Search relies on the system indexing pages, configurations might behave differently on staging vs. production environments. Make sure you fully test results in a near-production environment to avoid last-minute surprises.
  5. Cache and Performance
    1. Index Maintenance: Regularly clean and re-index your site, especially after large content updates or changes to the site structure.
    2. Exclude Irrelevant Pages: Switch off “Include in Search” in the page properties for pages (like privacy policies or terms) whose content doesn’t need to be searched.

Free TYPO3 guides

Planning more than search? Get our free TYPO3 playbooks on upgrades, the EU AI Act, accessibility and more, each a PDF with TYPO3 v14 screens and an Excel sheet.

Get the free TYPO3 guides

3. Adding Search Box to Fluid Templates

After you’ve included the above TypoScript configuration, you can embed the search box directly into your Fluid templates. For example, if you have a Fluid template for your site’s main layout, you could add:

<f:section name="searchBox">
    <f:cObject typoscriptObjectPath="lib.searchBox" />
</f:section>

Then, in your Layout, you might do:

<!DOCTYPE html>
<html>
<head>
    <title><f:render section="title" /></title>
</head>
<body>
    <!-- Header -->
    <f:render partial="Header" />
    
    <!-- Search Box -->
    <f:render section="searchBox" />
    
    <!-- Main Content -->
    <f:render section="main" />
</body>
</html>

This approach keeps the search box reusable and centralized while maintaining a clean code structure.

4. How do you customize the Indexed Search templates?

Since TYPO3 13.3, set your own template paths in the site set settings instead of TypoScript. Add them to the settings.yaml of your site package set (or in the Settings editor):

# EXT:site_package/Configuration/Sets/SitePackage/settings.yaml
indexedsearch:
  view:
    templateRootPath: 'EXT:site_package/Resources/Private/Extensions/IndexedSearch/Templates/'
    partialRootPath: 'EXT:site_package/Resources/Private/Extensions/IndexedSearch/Partials/'
    layoutRootPath: 'EXT:site_package/Resources/Private/Extensions/IndexedSearch/Layouts/'

… then copy only the files you want to change from EXT:indexed_search/Resources/Private/ into these folders, for example the search form partial. Keep the file name of your TYPO3 version: v13 uses Partials/Form.html, v14 uses Partials/Form.fluid.html. This gives you total control over the front-end markup and style, while keeping updates separate from the core extension. Without site sets you can still extend plugin.tx_indexedsearch.view.templateRootPaths in TypoScript (Overriding the Fluid template).

5. Additional Considerations

  • Multilingual Sites: Ensure you’ve configured your site languages properly. Indexed Search indexes each language version separately and searches in the current site language, so every translated page must be cacheable and reachable.
  • Accessibility: Provide descriptive labels and ARIA attributes. A well-labeled search form is beneficial for keyboard navigation and screen readers.
  • Breadcrumbs and Search Results: You can customize the search results template to include breadcrumbs or other metadata that help users quickly find relevant content.

Why does TYPO3 Indexed Search show no results?

Most “no results” problems come from pages that were never indexed. Check these common mistakes in this order.

  • Pages are not cached. Indexed Search only indexes cacheable pages. config.no_cache or a plugin that disables the page cache prevents indexing.
  • Site set or TypoScript is missing. The plugin then shows “Please check that TypoScript for the Indexed Search plugin is included”. Add typo3/indexed-search to the site dependencies and clear the caches.
  • Frontend indexing is disabled, but no crawler runs. With “Disable Indexing in Frontend” enabled, only crawler runs fill the index.
  • PDFs are missing. pdftotext or pdfinfo is not installed, the file is not in a FAL storage, or the page links more files than “maxExternalFiles” allows.
  • Hyphenated words find nothing. With the MySQL fulltext option, MySQL splits “Berners-Lee” into two words and skips words shorter than ft_min_word_len (default 4). MariaDB does not have the hyphen problem (Known problems).
  • An old snippet breaks after an upgrade. Replace USER with switchableControllerActions by the EXTBASEPLUGIN snippet from section 1.
  • Results are outdated. Empty the index in the Indexing module and regenerate it, or check that the crawler tasks run.

Which TYPO3 search extension should you choose?

Use Indexed Search for small and medium sites that need full-text search without an extra server. Choose ke_search for faceted filters without extra server software, and Apache Solr, Elasticsearch or another engine when you need scale, synonyms or one search across several systems.

Solution (package)Works in TYPO3Search backendLicenseBest forCaveat
Indexed Search (typo3/cms-indexed-search)Core extension in v13.4 and v14.3TYPO3 databaseGPL-2.0-or-laterSmall to medium sites, linked PDFs, no extra serverAdvanced search offers sections and media types, but no faceted filters
ke_search (tpwd/ke_search 7.3)v13 and v14TYPO3 database, built-in indexersGPL-2.0-or-later, plus a paid premium versionFaceted search; the vendor states up to about 200,000 pages or recordsSome features only in the premium version
Apache Solr for TYPO3 (apache-solr-for-typo3/solr)v13.4 (EXT:solr 13.1), v14.3 (EXT:solr 14.0)Apache Solr server (recommended 9.10.1 for v13, 10.0.0 for v14)GPL-3.0-or-laterLarge sites, facets, synonym supportYou run and maintain a Solr server
Searchable (pagemachine/searchable 7.2)v13.4 and v14.3ElasticsearchGPL-3.0-or-laterTeams with Elasticsearch; TCA-based record indexing, command-line indexingNeeds an Elasticsearch server
SEAL (lochmueller/seal 2.0)v13.4 and v14.3, PHP 8.3+Adapters: TYPO3 database, Meilisearch, Solr, Loupe, TypesenseGPL-2.0-or-laterChanging the search engine without rewriting the integrationComposer mode only; requires EXT:index
mksearch (dmk/mksearch 13.0)v12.4 and v13.4Zend Lucene, Apache Solr or ElasticsearchGPL-2.0-or-laterExisting mksearch projectsNo TYPO3 v14 release yet
t3meilisearch (visuellverstehen/t3meilisearch 1.4)v11.5 to v13.4MeilisearchNo license stated on Packagistv13 sites that already run MeilisearchNo TYPO3 v14 release yet; PDFs need poppler-utils

Versions and TYPO3 support checked on Packagist and in the projects’ documentation in November 2026. Current TYPO3 releases: 14.3 LTS and 13.4 LTS (get.typo3.org).

Quick decision guide

  • Company or brochure site with a few hundred pages and linked PDFs: Indexed Search plus the Crawler.
  • Visitors need filters by category, date or type, and you cannot run extra servers: ke_search. Read part 2 of this series, our TYPO3 ke_search guide.
  • Large or multi-site installations with facets and synonyms: Apache Solr for TYPO3. Read part 3, our TYPO3 Solr search guide.
  • Elasticsearch or Meilisearch already in your stack: Searchable or SEAL.
  • Visitors ask questions instead of typing keywords: TYPO3 AI Search (T3AS) from T3Planet adds AI answers with their sources above the normal results of Indexed Search, ke_search or Solr, so you keep your current index.

More questions about TYPO3 Indexed Search

Is TYPO3 Indexed Search free?

Yes. Indexed Search is a TYPO3 system extension and is published under GPL-2.0-or-later, like the rest of the TYPO3 Core. There is no license fee and no external search service. The index lives in your TYPO3 database. The Crawler extension for scheduled indexing is free as well (GPL-3.0). Optional helpers such as pdftotext run on your own server.

Does Indexed Search work with TYPO3 v14?

Yes. Indexed Search ships with TYPO3 14.3 LTS and 13.4 LTS, and the official documentation covers both versions. The plugin, the site set and the extension settings are the same. One difference matters for integrators: in v14 the Fluid templates are named *.fluid.html, for example Partials/Form.fluid.html, so use that file name when you override templates.

Can Indexed Search index news and other records?

Yes, with an indexing configuration of the type “Database Records”. Place it on the page with the news single view, choose the table, the fields to index (for example title, short, text) and a GET parameter string such as &tx_news[action]=show&tx_news[news]=###UID###. The crawler then indexes the records and removes deleted ones on the next run.

Do I need the Crawler extension?

Not for a small site. Without the crawler, pages enter the index when visitors open them and the page is cached. You need the crawler for complete, scheduled indexing, for indexing configurations (records, external URLs and file directories) and whenever you disable frontend indexing. It runs from the command line or as scheduler tasks.

Conclusion

With the above TypoScript snippet, you already have a flexible, Extbase-based search box that leverages the power of TYPO3’s Indexed Search in v13 and v14. By following best practices around maintenance, caching, partials, and template overrides, and by scheduling the Crawler, you can provide a rich and efficient search experience.

This post is part 1 of our TYPO3 search series. Part 2 covers ke_search for faceted search, part 3 Apache Solr for TYPO3.

If you have further questions or want to dive deeper into advanced topics like pagination customization, extended search filters, or additional indexing strategies, feel free to explore more options within Indexed Search and share your findings with the TYPO3 community. Experimentation and a solid testing routine are key to ensuring your search feature remains functional, fast, and user-friendly.

Happy TYPO3 coding! If you’re eager to go beyond the basics, continue exploring advanced search filtering, search suggestions, or even connecting external data sources into TYPO3’s Indexed Search.

Upgrading to TYPO3 v14?

Removed options such as switchableControllerActions are one reason why search boxes break after an upgrade. The free Upgrade Playbook for TYPO3 plans your upgrade in four phases, with a maintenance calendar, ELTS facts and an Excel worksheet.

Download the Upgrade Playbook

You May Also Like