Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Apache Lucene open-source search software
29,923 Commits 29 Branches 469 Tags 768 MiB
Java 97.7%
HTML 1%
Python 0.9%
Lex 0.3%
Go to file
Simon Willnauer ac027145fb [TEST] Set stop flag in the case of an exception 2018-04-24 17:57:33 +02:00
dev-tools LUCENE-8231: Add a new analysis module (nori) similar to Kuromoji but to handle Korean 2018-04-13 11:26:42 +02:00
lucene [TEST] Set stop flag in the case of an exception 2018-04-24 17:57:33 +02:00
solr SOLR-11833: Clarify the meaning of "waitFor". Other minor edits. 2018-04-24 12:22:01 +02:00
.gitignore .gitignore: /maven-build 2017-09-20 15:31:25 -04:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
README.md LUCENE-7978: Add some more documentation about setting up build environment; merge branch 'LUCENE-7978' of https://github.com/antonmry/lucene-solr 2017-09-29 14:53:56 +02:00
build.xml Add a description to all public targets 2018-04-01 14:40:33 +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
  • IntelliJ - ant idea
  • Netbeans - ant netbeans

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