Google Git
Sign in
apache / lucene-solr / e96ed6d7f52a4e674e7ab7e3e69a8ea4ebf167ed
commite96ed6d7f52a4e674e7ab7e3e69a8ea4ebf167ed[log] [tgz]
authormarkrmiller <markrmiller@apache.org>Sun Jun 16 10:13:22 2019 -0500
committermarkrmiller <markrmiller@apache.org>Sun Jun 16 10:13:22 2019 -0500
tree0c324b169f81f93b0a3aab1963e5289096eca98d
parent910f383832d712a0032a60446c570da6071ff2a9 [diff]
SOLR-13452: More work on dependencies and related tasks.
14 files changed
tree: 0c324b169f81f93b0a3aab1963e5289096eca98d
  1. buildSrc/
  2. dev-tools/
  3. gradle/
  4. lucene/
  5. solr/
  6. .gitignore
  7. .hgignore
  8. build.gradle
  9. build.xml
  10. gradle.properties
  11. gradlew
  12. gradlew.bat
  13. README.md
  14. settings.gradle
  15. versions.lock
  16. versions.props
README.md

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.

Online Documentation

This README file only contains basic setup instructions. For more comprehensive documentation, visit:

Building Lucene/Solr

(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

Running Solr

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.

Development/IDEs

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)

Running Tests

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

Contributing

Please review the Contributing to Solr Guide for information on contributing.

Discussion and Support