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.

tx_solr.solr

This section defines the address of the Solr server. As the communication with the Solr server happens over HTTP this is just a simple URL. Each of the URL’s components can be defined separately.

Note: Since version 9 of EXT:solr you can optionally configure different endpoints for reading and writing

plugin.tx_solr.solr {
   read {
      scheme = https
      host = localhost
      port = 8983
      path = /solr/core_en/
   }
   write < .read
}

As fallback (when nothing special is configured in read or write, EXT:solr is fallingback to the old global setting)

Example:

  • When nothing is configured in `plugin.tx_solr.solr.read.host` the path ```plugin.tx_solr.solr.host```is used.

scheme

Type:String
TS Path:plugin.tx_solr.solr.scheme
Default:http
Options:http, https
cObject supported:
 yes
Since:1.2 2.0

Allows to set the connection scheme to “https” instead of the default “http”.

host

Type:String
TS Path:plugin.tx_solr.solr.host
Default:localhost
cObject supported:
 yes
Since:1.0

Sets the host portion of the URL.

port

Type:Integer
TS Path:plugin.tx_solr.solr.port
Default:8983
cObject supported:
 yes
Since:1.0

Sets the port portion of the URL.

path

Type:String
TS Path:plugin.tx_solr.solr.path
Default:/
cObject supported:
 yes
Since:1.0

Sets the path portion of the URL. Make sure to have the path end with a slash (/).

username

Type:String
TS Path:plugin.tx_solr.solr.username
Since:6.0
cObject supported:
 yes

Sets the username required to access the solr server.

password

Type:String
TS Path:plugin.tx_solr.solr.password
Since:6.0
cObject supported:
 yes

Sets the password required to access the solr server.

timeout

Type:Float
TS Path:plugin.tx_solr.solr.timeout
Default:0.0
Since:1.0
cObject supported:
 no

Can be used to configure a connection timeout.