| commit | e25ab4204fc4e2673b23b09d9a99e90dc401b03f | [log] [tgz] |
|---|---|---|
| author | Mike Drob <mdrob@apache.org> | Mon Mar 30 10:12:29 2020 -0500 |
| committer | Mike Drob <mdrob@apache.org> | Thu Apr 02 11:30:01 2020 -0500 |
| tree | 3909a6507b2e4b95bacf04b48522bdc73257dd33 | |
| parent | 927587d8ad908a7e2d25c99ad1db27967be42057 [diff] |
LUCENE-9266 remove gradle wrapper jar from source ASF Release Policy states that we cannot have binary JAR files checked in to our source releases, a few other projects have solved this by modifying their generated gradlew scripts to download a copy of the wrapper jar. We now have a version and checksum file in ./gradle/wrapper directory used for verifying the wrapper jar, and will take advantage of single source java execution to verify and download. The gradle wrapper jar will continue to be available in the git repository, but will be excluded from src tarball generation. This should not change workflows for any users, since we expect the gradlew script to get the jar when it is missing. Co-authored-by: Dawid Weiss <dweiss@apache.org>
Apache Lucene is a high-performance, full featured text search engine library written in Java.
Apache Solr is an enterprise search platform written using Apache Lucene. Major features include full-text search, index replication and sharding, and result faceting and highlighting.
This README file only contains basic setup instructions. For more comprehensive documentation, visit:
(You do not need to do this if you downloaded a pre-built package)
Lucene and Solr are built using Apache Ant. To build Lucene and Solr, run:
ant compile
If you see an error about Ivy missing while invoking Ant (e.g., .ant/lib does not exist), run ant ivy-bootstrap and retry.
Sometimes you may face issues with Ivy (e.g., an incompletely downloaded artifact). Cleaning up the Ivy cache and retrying is a workaround for most of such issues:
rm -rf ~/.ivy2/cache
The Solr server can then be packaged and prepared for startup by running the following command from the solr/ directory:
ant server
There is ongoing work (see LUCENE-9077) to switch the legacy ant-based build system to gradle. Please give it a try!
At the moment of writing, the gradle build requires precisely Java 11 (it may or may not work with newer Java versions).
To build Lucene and Solr, run (./ can be omitted on Windows):
./gradlew assemble
The command above also packages a full distribution of Solr server; the package can be located at:
solr/packaging/build/solr-*
Note that the gradle build does not create or copy binaries throughout the source repository (like ant build does) so you need to switch to the packaging output folder above; the rest of the instructions below remain identical.
After building Solr, the server can be started using the bin/solr control scripts. Solr can be run in either standalone or distributed (SolrCloud mode).
To run Solr in standalone mode, run the following command from the solr/ directory:
bin/solr start
To run Solr in SolrCloud mode, run the following command from the solr/ directory:
bin/solr start -c
The bin/solr control script allows heavy modification of the started Solr. Common options are described in some detail in solr/README.txt. For an exhaustive treatment of options, run bin/solr start -h from the solr/ directory.
Ant can be used to generate project files compatible with most common IDEs. Run the ant command corresponding to your IDE of choice before attempting to import Lucene/Solr.
ant eclipse (See this for details)ant idea (See this for details)ant netbeans (See this for details)The standard test suite can be run with the command:
ant test
Like Solr itself, the test-running can be customized or tailored in a number or ways. For an exhaustive discussion of the options available, run:
ant test-help
Run the following command to display an extensive help for running tests with gradle:
./gradlew helpTests
Please review the Contributing to Solr Guide for information on contributing.
#solr and #solr-dev on freenode.net