ftw.recipe.solr

A zc.buildout recipe to install a Solr server


License
GPL-2.0
Install
pip install ftw.recipe.solr==1.3.1

Documentation

Introduction

This recipe installs a Solr server with buildout.

It's kept as simple as possible and contrary to collective.recipe.solrinstance it does not generate any Solr configuration files. Instead the user can provide a directory containing custom configuration files. A default set of configuration files for usage with Plone is provided.

You can use it by adding a part like this:

[buildout]
parts = solr

[solr]
recipe = ftw.recipe.solr
cores =
    core1

Supported options

The recipe supports the following options:

host

Name or IP address of the Solr server. Defaults to localhost.

port

Server port. Defaults to 8983.

cores

List of cores that should be created.

url

Url for Solr distribution download.

md5sum

MD5 checksum of Solr distribution.

jvm-opts

Can be used to configure JVM options. Defaults to -Xms512m -Xmx512m -Xss256k

extra-opts

Extra options to pass to the Solr command line (separated by space). Empty by default.

conf

Path to a directory containing Solr configuration files.

conf-egg

If provided, the path given in conf is prepended with the path of the given egg.

shards-whitelist

If specified, this list limits what nodes can be requested in the shards request parameter. See Configuring the ShardHandlerFactory

configoverlay

Provide a configoverlay as documented in https://lucene.apache.org/solr/guide/8_4/config-api.html. This will override the default config in solrconfig.xml

Links

Copyright

This package is copyright by 4teamwork.

ftw.recipe.solr is licensed under GNU General Public License, version 2.