Apache Solr for TYPO3

https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/
Admin
Apache Solr for TYPO3 is an enterprise search extension for the TYPO3 CMS that integrates the Apache...
Tokens:267,260
Snippets:1,989
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install EXT:solr via Composer

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/GettingStarted/InstallTYPO3Extension.html

Use this command to install the extension using the Composer dependency manager.

```bash
composer require apache-solr-for-typo3/solr
```

--------------------------------

### Boost Function Examples

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrSearch.html

Examples of using recip and termfreq functions to influence document relevance scores.

```text
recip(ms(NOW,created),3.16e-11,1,1)
```

```text
termfreq(type,'tx_solr_file')
```

--------------------------------

### Deploy EXT:solr configuration into Solr installation

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/GettingStarted/Solr.html

Copies the EXT:solr configSet directory and JAR files into a prepared Solr installation, replacing the solr.xml file. This is the recommended deployment approach for Infrastructure as Code (IaC).

```bash
cp -r ${EXTENSION_ROOTPATH}/Resources/Private/Solr/* ${SOLR_INSTALL_DIR}/server/solr
```

--------------------------------

### Configure numericRange facet as a slider

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrSearch.html

Example of configuring a facet with the numericRange type, including start, end, and gap settings.

```typoscript
plugin.tx_solr.search.faceting.facets.size {
     field = size_intS
     label = Size

     type = numericRange
     numericRange {
         start = 0
         end = 100
         gap = 1
    }
}
```

--------------------------------

### Install EXT:solr via Git

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/GettingStarted/InstallTYPO3Extension.html

Use this command to clone the latest development version of the extension from the GitHub repository.

```bash
$ git clone git@github.com:TYPO3-Solr/ext-solr.git solr
```

--------------------------------

### Build Dockerfile image and run container with local volume

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/FAQ/Index.html

Shows how to build the Dockerfile image and start a container with a mapped local volume for data. Tested with Docker for Mac (not Docker Toolbox). Requires adding '/solrdata' as allowed volume in Docker configuration before executing.

```bash
# build the image
docker build -t typo3-solr -f Docker/SolrServer/Dockerfile .

# create volume directory locally
mkdir -p ~/solrdata

# add Solr group to volume directory
sudo chown :8983 ~/solrdata

# run Docker container from image with volume
docker run -d -p 127.0.0.1:8282:8983 -v ~/solrdata:/var/solr/data/data typo3-solr

```

--------------------------------

### Set Faceting URL Parameter Style

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrSearch.html

Example of setting the URL parameter style to associative mode in a TypoScript setup file.

```typoscript
plugin.tx_solr.search.faceting {
  urlParameterStyle = assoc
}
```

--------------------------------

### Bootstrap the test environment

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Development/CI.html

Run this command once to bootstrap the test environment. It exports environment variables for the TYPO3 testing framework, creates the test database, and creates a test Solr instance.

```bash
source ./Build/Test/bootstrap.sh --local
```

--------------------------------

### Manual sort order example

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrSearch.html

Example showing the default order of a category facet before applying manual sorting.

```text
News Category
+ Politics (256)
+ Sports (212)
+ Economy (185)
+ Culture (179)
+ Health (132)
+ Automobile (99)
+ Travel (51)
```

--------------------------------

### Example core.properties file

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Solr/ConfigurationStructures.html

Shows the structure of a core.properties file that references a configSet and schema. The path to the schema is relative to the root folder of the configSet.

```properties
configSet=ext_solr_6_0_0
schema=german/schema.xml
name=core_de
dataDir=../../data/german
```

--------------------------------

### fieldProcessingInstructions example

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrIndex.html

Assigns processing instructions to Solr fields. The example converts the 'changed', 'created', and 'endtime' fields to ISO dates.

```typoscript
fieldProcessingInstructions {
    changed = timestampToIsoDate
    created = timestampToIsoDate
    endtime = timestampToIsoDate
}
```

--------------------------------

### Configure custom GET parameter name

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrSearch.html

Sets a custom GET parameter name for search queries, useful for compatibility with tracking tools.

```typoscript
plugin.tx_solr.search.query.getParameter = q
```

--------------------------------

### Configure queue index types with TypoScript

Source: https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrIndex.html

Example showing how to define index types for different configurations, including extending existing configurations and overriding fields.

```typoscript
plugin.tx_solr.index.queue.generalNews {
  type = tt_news
  fields.url = URL for the general news
  // more field configurations here ...
}

// extends the general news configuration
plugin.tx_solr.index.queue.pressNews < plugin.tx_solr.index.queue.generalNews
plugin.tx_solr.index.queue.pressNews {
  fields.url = overwriting URL for the press announcements
  // may overwrite or unset more settings from the general configuration
}

// completely different configuration
plugin.tx_solr.index.queue.productNews {
  type = tt_news
  fields.url = URL for the product news
}
```
Tokens:
Raw