Introduction
============
This recipe installs a `Solr <http://lucene.apache.org/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
<https://lucene.apache.org/solr/guide/8_1/distributed-requests.html#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
=====
- Github: https://github.com/4teamwork/ftw.recipe.solr
- Issues: https://github.com/4teamwork/ftw.recipe.solr/issues
- Pypi: http://pypi.python.org/pypi/ftw.recipe.solr
- Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.recipe.solr
Copyright
=========
This package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.
``ftw.recipe.solr`` is licensed under GNU General Public License, version 2.
Changelog
=========
1.3.9 (2024-04-02)
------------------
- Use system property to enable remote streaming.
[buchi]
1.3.8 (2023-10-12)
------------------
- Add support for `extra-opts` (additional options for Solr cmdline).
[lgraf]
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]
Raw data
{
"_id": null,
"home_page": "https://github.com/4teamwork/ftw.recipe.solr",
"name": "ftw.recipe.solr",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "4teamwork AG",
"author_email": "mailto:info@4teamwork.ch",
"download_url": "https://files.pythonhosted.org/packages/19/19/8818dbf1aeab544af492d3d17ce11f33a63c7bbe11a15e47da31cbd28c1c/ftw.recipe.solr-1.3.9.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nThis recipe installs a `Solr <http://lucene.apache.org/solr/>`_\nserver with buildout.\n\nIt's kept as simple as possible and contrary to `collective.recipe.solrinstance`\nit does not generate any Solr configuration files. Instead the user can provide\na directory containing custom configuration files. A default set of configuration\nfiles for usage with Plone is provided.\n\nYou can use it by adding a part like this::\n\n [buildout]\n parts = solr\n\n [solr]\n recipe = ftw.recipe.solr\n cores =\n core1\n\n\nSupported options\n=================\n\nThe recipe supports the following options:\n\nhost\n Name or IP address of the Solr server. Defaults to ``localhost``.\n\nport\n Server port. Defaults to ``8983``.\n\ncores\n List of cores that should be created.\n\nurl\n Url for Solr distribution download.\n\nmd5sum\n MD5 checksum of Solr distribution.\n\njvm-opts\n Can be used to configure JVM options. Defaults to\n ``-Xms512m -Xmx512m -Xss256k``\n\nextra-opts\n Extra options to pass to the Solr command line (separated by space). Empty by default.\n\nconf\n Path to a directory containing Solr configuration files.\n\nconf-egg\n If provided, the path given in `conf` is prepended with the path of the\n given egg.\n\nshards-whitelist\n If specified, this list limits what nodes can be requested in the shards\n request parameter. See `Configuring the ShardHandlerFactory\n <https://lucene.apache.org/solr/guide/8_1/distributed-requests.html#configuring-the-shardhandlerfactory>`_\n\nconfigoverlay\n Provide a configoverlay as documented in https://lucene.apache.org/solr/guide/8_4/config-api.html.\n This will override the default config in ``solrconfig.xml``\n\n\nLinks\n=====\n\n- Github: https://github.com/4teamwork/ftw.recipe.solr\n- Issues: https://github.com/4teamwork/ftw.recipe.solr/issues\n- Pypi: http://pypi.python.org/pypi/ftw.recipe.solr\n- Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.recipe.solr\n\n\nCopyright\n=========\n\nThis package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.\n\n``ftw.recipe.solr`` is licensed under GNU General Public License, version 2.\n\nChangelog\n=========\n\n1.3.9 (2024-04-02)\n------------------\n\n- Use system property to enable remote streaming.\n [buchi]\n\n\n1.3.8 (2023-10-12)\n------------------\n\n- Add support for `extra-opts` (additional options for Solr cmdline).\n [lgraf]\n\n\n1.3.7 (2022-07-05)\n------------------\n\n- Add support for subdirectories in the configuration directory.\n [buchi]\n\n\n1.3.6 (2021-12-20)\n------------------\n\n- Fix system property for Log4j configuration file.\n\n\n1.3.5 (2021-12-13)\n------------------\n\n- Disable message lookups in log4j. Mitigation for CVE-2021-44228.\n [buchi]\n\n\n1.3.4 (2020-07-31)\n------------------\n\n- Add configoverlay option. [Kevin Bieri]\n\n\n1.3.3 (2020-05-27)\n------------------\n\n- Add shardsWhitelist to template. [lvonlanthen]\n\n\n1.3.2 (2020-01-15)\n------------------\n\n- Fix detection of running Solr on Linux used in `bin/solr stop` and `bin/solr status`.\n [siegy22]\n\n\n1.3.1 (2019-07-08)\n------------------\n\n- Respect SOLR environment variables set outside of the startup script [jone].\n\n\n1.3.0 (2019-06-13)\n------------------\n\n- Update Log4J configuration: Replace log4j.properties with log4j2.xml.\n Requires Solr 7.4.0 or later.\n [buchi]\n\n- Update default URL and solrconfig.xml to version 8.1.1.\n [buchi]\n\n- Add sortable_title and path_depth fields to provided schema.\n [buchi]\n\n\n1.2.1 (2018-09-20)\n------------------\n\n- Add ICUNormalizer2CharFilterFactory char filter in provided schema.\n This fixes handling of decomposed unicode (aka NFD, NFKD).\n [buchi]\n\n- Replace shell process by Solr process when starting in foreground.\n [buchi]\n\n\n1.2.0 (2018-05-25)\n------------------\n\n- Only chmod startup script to executable if it's not already executable.\n [buchi]\n\n- Update default download url to version 7.3.1.\n [buchi]\n\n- Add missing Plone default fields to provided schema.\n [buchi]\n\n\n1.1.0 (2018-02-05)\n------------------\n\n- Add option to provide the Solr conf relative to an egg.\n [buchi]\n\n\n1.0.0 (2018-02-02)\n------------------\n\n- Initial release.\n [buchi]\n",
"bugtrack_url": null,
"license": "GPL2",
"summary": "A zc.buildout recipe to install a Solr server",
"version": "1.3.9",
"project_urls": {
"Homepage": "https://github.com/4teamwork/ftw.recipe.solr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19198818dbf1aeab544af492d3d17ce11f33a63c7bbe11a15e47da31cbd28c1c",
"md5": "0a3634919a5b428622aa7c9603019d20",
"sha256": "170ce463e12f5f82d2dd0a08dcaa322043510eb0400100bfc2639379c267fad4"
},
"downloads": -1,
"filename": "ftw.recipe.solr-1.3.9.tar.gz",
"has_sig": false,
"md5_digest": "0a3634919a5b428622aa7c9603019d20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 50519,
"upload_time": "2024-04-04T11:34:03",
"upload_time_iso_8601": "2024-04-04T11:34:03.435467Z",
"url": "https://files.pythonhosted.org/packages/19/19/8818dbf1aeab544af492d3d17ce11f33a63c7bbe11a15e47da31cbd28c1c/ftw.recipe.solr-1.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 11:34:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4teamwork",
"github_project": "ftw.recipe.solr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ftw.recipe.solr"
}
JSON
