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
28,257 Commits 28 Branches 466 Tags 740 MiB
Java 97.7%
HTML 1%
Python 0.8%
Lex 0.3%
Go to file
Cassandra Targett 2351e3ef1f SOLR-9959: Ref Guide changes for JMX and metric name changes 2017-09-20 10:27:59 -05:00
dev-tools Update DOAP files with 6.6.1 release 2017-09-06 22:15:44 -07:00
lucene LUCENE-7392: Add point based LatLonBoundingBox as new RangeField Type. 2017-09-19 14:45:04 -05:00
solr SOLR-9959: Ref Guide changes for JMX and metric name changes 2017-09-20 10:27:59 -05:00
.gitignore SOLR-10713: Add common output files to .gitignore 2017-06-05 12:49:50 -05:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
README.md LUCENE-5822 Add markdown-compatible README.md 2017-06-30 10:57:09 -05:00
build.xml SOLR-11181: fix validate-maven-dependencies 2017-09-07 09:24:02 -04: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

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