Supported options

The recipe supports the following options:

solr-location

Path to the location of the Solr installation. This should be the top-level installation directory.

host

Name or IP address of the Solr server, e.g. some.server.com. Defaults to 'localhost'.

port

Server port. Defaults to 8983.

basepath

Base path to the Solr service on the server. The final URL to the Solr service will be made of

$host:$port/$basepath

to which the actual commands will be appended. Defaults to '/solr'.

config-destination

Optional override for the directory where the solrconfig.xml file will be generated. Defaults to the Solr default location.

config-template

Optional override for the template used to generate the solrconfig.xml file. Defaults to the template contained in the recipe, i.e. templates/solrconfig.xml.tmpl.

schema-destination

Optional override for the directory where the schema.xml file will be generated. Defaults to the Solr default location.

schema-template

Optional override for the template used to generate the schema.xml file. Defaults to the template contained in the recipe, i.e. templates/schema.xml.tmpl.

jetty-destination

Optional override for the directory where the jetty.xml file will be generated. Defaults to the Solr default location.

index

Configures the different types of index fields provided by the Solr instance. Each field is configured on a separated line. Each line contains a white-space separated list of [key]:[value] pairs which define the index.

filter

Configure the additional filters for each index type. Each filter is configured on a separated line. Each line contains a index params pair, where index is one of the existing index types and params contains [key]:[value] items to configure the filter. Check the available filters in Solr's docs: http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters

unique-key

Optional override for declaring a field to be unique for all documents. See http://wiki.apache.org/solr/SchemaXml for more information Defaults to 'uid'.

default-search-field

Configure a default search field, which is used when no field was explicitly given. See http://wiki.apache.org/solr/SchemaXml.

max-num-results

The maximum number of results the Solr server returns. Defaults to 10.

section-name

Name of the product-config section to be generated for zope.conf. Defaults to 'solr'.

zope-conf

Optional override for the configuration snippet that is generated to be included in zope.conf by other recipes. Defaults to:

<product-config ${part:section-name}>
    address ${part:host}:${part:port}
    basepath ${part:basepath}
</product-config>

default-operator

The default operator to use for queries. Valid values or AND and OR. Defaults to OR.

additional-solrconf

Optional additional configuration to be included inside the solrconfig.xml. For instance, <requestHandler /> directives.

requestParsers-multipartUploadLimitInKB

Optional <requestParsers /> parameter useful if you are submitting very large documents to Solr. May be the case with Solr >= 1.4 if Solr is indexing binaries extracted from request.

vardir

Optional override for the location of the directory where Solr stores its indexes and log files. Defaults to ${buildout:directory}/var/solr. This option and the script option make it possible to create multiple Solr instances in a single buildout and dedicate one or more of the instances to automated functional testing.

script

Optional override for the name of the generated Solr instance control script. Defaults to solr-instance. This option and the vardir option make it possible to create multiple Solr instances in a single buildout and dedicate one or more of the instances to automated functional testing.

0.3 (2009/09/10)

• Added requestParsers-multipartUploadLimitInKB allowing one to adjust the request parsers limit. [anguenot]
• Added additional-solrconfig allowing one to extend the solrconfig.xml [anguenot]
• Support whitespace in schema index attributes values [anguenot]
• Added default-operator [swampmonkey]
• Added config-template for allowing an alternate template to be used for generating the solrconfig.xml file. [cguardia]
• Added the vardir and script options, making it possible to install multiple Solr instances in a single buildout.

0.2 (2008-08-08)

• Improved stop command by using SIGTERM instead of SIGHUP [guido_w]
• Made that stdout and stderr get redirected to a log file when daemonizing the solr instance [guido_w]

0.1 (2008-07-07)

• First public release.