Skip to main content

A zc.buildout recipe to install a Solr server

Project description

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

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

Changelog

1.3.7 (2022-07-05)

  • Add support for subdirectories in the configuration directory. [buchi]

1.3.6 (2021-12-20)

  • Fix system property for Log4j configuration file.

1.3.5 (2021-12-13)

  • Disable message lookups in log4j. Mitigation for CVE-2021-44228. [buchi]

1.3.4 (2020-07-31)

  • Add configoverlay option. [Kevin Bieri]

1.3.3 (2020-05-27)

  • Add shardsWhitelist to template. [lvonlanthen]

1.3.2 (2020-01-15)

  • Fix detection of running Solr on Linux used in bin/solr stop and bin/solr status. [siegy22]

1.3.1 (2019-07-08)

  • Respect SOLR environment variables set outside of the startup script [jone].

1.3.0 (2019-06-13)

  • Update Log4J configuration: Replace log4j.properties with log4j2.xml. Requires Solr 7.4.0 or later. [buchi]

  • Update default URL and solrconfig.xml to version 8.1.1. [buchi]

  • Add sortable_title and path_depth fields to provided schema. [buchi]

1.2.1 (2018-09-20)

  • Add ICUNormalizer2CharFilterFactory char filter in provided schema. This fixes handling of decomposed unicode (aka NFD, NFKD). [buchi]

  • Replace shell process by Solr process when starting in foreground. [buchi]

1.2.0 (2018-05-25)

  • Only chmod startup script to executable if it’s not already executable. [buchi]

  • Update default download url to version 7.3.1. [buchi]

  • Add missing Plone default fields to provided schema. [buchi]

1.1.0 (2018-02-05)

  • Add option to provide the Solr conf relative to an egg. [buchi]

1.0.0 (2018-02-02)

  • Initial release. [buchi]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ftw.recipe.solr-1.3.7.tar.gz (50.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page