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
32,464 Commits 29 Branches 469 Tags 740 MiB
Java 97.7%
HTML 1%
Python 0.9%
Lex 0.3%
Go to file
epugh 2e6119e8fd tweak documentation to be clearer about uprefix 2019-10-20 23:50:42 -04:00
.github SOLR-13775: Add note about permissions to "PR Template" (#891) 2019-09-19 15:37:48 -04:00
dev-tools SOLR-12786: add back explicit asciidoctor install for Jenkins build 2019-10-16 12:21:48 -05:00
lucene LUCENE-9005: BooleanQuery.visit() pulls subvisitors from a top-level MUST visitor 2019-10-16 17:25:45 +01:00
solr tweak documentation to be clearer about uprefix 2019-10-20 23:50:42 -04:00
.gitignore SOLR-13674: NodeAddedTrigger does not support configuration of replica type hint. 2019-08-08 15:14:55 +05:30
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
README.md Remove extra period 2019-09-15 05:12:12 +09: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.

Build Status Build Status

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