Apache Lucene open-source search software
Go to file
Atri Sharma 965fd194d1 LUCENE-8825: Improve CheckHits's Printing Capabilities
Signed-off-by: Adrien Grand <jpountz@gmail.com>
2019-06-07 18:47:41 +02:00
dev-tools LUCENE-8802: buildAndPushRelease --logfile arg (#679) 2019-06-06 21:47:50 +02:00
lucene LUCENE-8825: Improve CheckHits's Printing Capabilities 2019-06-07 18:47:41 +02:00
solr SOLR-13496: Fix distributed grouping related NullPointerException in JSONWriter.writeSolrDocument 2019-06-07 16:05:10 +01:00
.gitignore Ignore python caches 2019-06-05 10:56:57 +02:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
README.md docs(intelliJSetup): Mention the link related to project-setup in IDE 2019-01-20 12:20:11 -08:00
build.xml Update JGit for working copy checks and explicitely set nop-logging 2019-04-20 01:55:23 +02:00

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