Apache Lucene and Solr
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)
Building with Ant
Lucene and Solr are built using Apache Ant. To build Lucene and Solr, run:
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
Building with Gradle
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):
The command above also packages a full distribution of Solr server; the package can be located at:
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
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
To run Solr in SolrCloud mode, run the following command from the
bin/solr start -c
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
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.
- Eclipse -
ant eclipse(See this for details)
- IntelliJ -
ant idea(See this for details)
- Netbeans -
ant netbeans(See this for details)
Gradle build and IDE support
- IntelliJ - IntelliJ idea can import the project out of the box. Code formatting conventions should be manually adjusted.
- Eclipse - Not tested.
- Netbeans - Not tested.
The standard test suite can be run with the command:
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:
Gradle build and tests
Run the following command to display an extensive help for running tests with gradle:
Please review the Contributing to Solr Guide for information on contributing.