DDEV TYPO3 Solr

Overview

Apache Solr is the blazing-fast, open source, multi-modal search platform built on the full-text, vector, and geospatial search capabilities of Apache Lucene™.

This add-on integrates Solr into your DDEV project and creates Solr cores according to the configuration defined in .ddev/typo3-solr/config.yaml.

This add-on is tailored to work with the TYPO3 extension solr. It now supports both server modes: standalone, solrcloud.

Installation

ddev add-on get ddev/ddev-typo3-solr
ddev restart

After installation, make sure to commit the .ddev directory to version control.

Usage

Configuration

Create cores and its configuration

Configuration example for TYPO3 in .ddev/typo3-solr/config.yaml:

config: 'vendor/apache-solr-for-typo3/solr/Resources/Private/Solr/solr.xml'
typo3lib: "vendor/apache-solr-for-typo3/solr/Resources/Private/Solr/typo3lib"
configsets:
    - name: "ext_solr_13_1_0"
      path: "vendor/apache-solr-for-typo3/solr/Resources/Private/Solr/configsets/ext_solr_13_1_0"
      cores:
          - name: "core_en"
            schema: "english/schema.xml"
          - name: "core_de"
            schema: "german/schema.xml"

ddev solrctl apply

To ensure the cores are created automatically on boot, add the following hook to your .ddev/config.yaml:

hooks:
  post-start:
    - exec-host: ddev solrctl apply

Example configuration for TYPO3

To connect to the solr service you have to configure the following lines in your site configuration:

solr_enabled_read: true
solr_host_read: <your-site>.ddev.site
solr_path_read: /
solr_port_read: '8984'
solr_scheme_read: https

Delete cores and its configuration

ddev solrctl wipe

Running the solr control script

ddev solr

Advanced Customization

Switching between standalone and SolrCloud mode

Solr initializes its data directory at first boot in a mode-specific layout. Switching modes on an existing volume will fail — the volume must be removed first.

# Set the desired mode
ddev dotenv set .ddev/.env.typo3-solr --solr-mode="solrcloud"

ddev stop

# Remove the Solr volume (required when switching modes)
docker volume rm ddev-$(ddev status -j | docker run -i --rm ddev/ddev-utilities jq -r '.raw.name')_typo3-solr

ddev restart
ddev solrctl apply

Make sure to commit the .ddev/.env.typo3-solr file to version control.

Using alternate versions of Solr

This addon defaults to installing a preferred version of the docker Solr image, but can be configured to use a different version via environment variable (SOLR_BASE_IMAGE).

# Change image version as appropriate.
ddev dotenv set .ddev/.env.typo3-solr --solr-base-image="solr:9.8"

ddev add-on get ddev/ddev-typo3-solr

# Remove old solr volume (required for downgrades)
ddev stop
docker volume rm ddev-$(ddev status -j | docker run -i --rm ddev/ddev-utilities jq -r '.raw.name')_typo3-solr

# Rebuild solr image (required step)
ddev debug rebuild -s typo3-solr

ddev restart

# Confirm the new Solr version
ddev solr version

Make sure to commit the .ddev/.env.typo3-solr file to version control.

All customization options (use with caution):

Credits

Maintained by @b13