Apache Lucene open-source search software
Go to file
David Smiley daeaffa9d7
SOLR-14433: Improve SolrShardReporter default metrics list (#1453)
Now includes TLOG and UPDATE./update.
These were small bugs to begin with but from user perspective this is an incremental improvement.
2020-04-27 23:48:34 -04:00
.github LUCENE-9266 remove gradle wrapper jar from source 2020-04-02 11:30:01 -05:00
buildSrc LUCENE-9266 remove gradle wrapper jar from source 2020-04-02 11:30:01 -05:00
dev-docs Revert "SOLR-12930: move Gradle docs from ./help/ to new ./dev-docs/ directory" 2020-01-24 15:56:00 -06:00
dev-tools LUCENE-9191: make LineFileDocs random seeking more efficient by recording safe skip points in the concatenated gzip'd chunks 2020-04-21 12:09:17 -04:00
gradle LUCENE-7788: fail precommit on unparameterised log messages and examine for wasted work/objects 2020-04-27 20:45:57 -04:00
help LUCENE-7788: fail precommit on unparameterised log messages and examine for wasted work/objects 2020-04-27 20:45:57 -04:00
lucene Fix visibility on member variables in IndexWriter and friends (#1460) 2020-04-27 17:49:20 +02:00
solr SOLR-14433: Improve SolrShardReporter default metrics list (#1453) 2020-04-27 23:48:34 -04:00
.asf.yaml Configure notifications. 2020-04-22 15:23:13 +02:00
.gitattributes LUCENE-9077: make git always keep .gradle files with LF EOLs. 2020-04-09 13:55:16 +02:00
.gitignore Generate hardware-specific defaults for gradle parallelism on the first build run (any task). Add some explanations on how to tweak local settings even further (gradlew :helpLocalSettings 2019-12-05 11:14:09 +01:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
LICENSE LUCENE-9233 Add top level LICENSE file 2020-02-20 20:53:57 +01:00
README.md Add gradle-relevant readme sections. 2020-01-09 12:36:40 +01:00
build.gradle LUCENE-9347: Add support for forbiddenapis 3.0 (#1459) 2020-04-27 11:54:59 +02:00
build.xml LUCENE-9230: explicitly call python version we want from builds 2020-02-18 18:58:17 -05:00
gradlew Support running gradlew from subdir 2020-04-03 15:16:08 -05:00
gradlew.bat LUCENE-9266: correct windows gradle wrapper download script - wrong placement of the quote. 2020-04-08 12:56:39 +02:00
settings.gradle LUCENE-9182: add apache license headers to all .gradle files and enforce in rat task 2020-01-27 12:05:34 -05:00
versions.lock SOLR-14386: Update Jetty to 9.4.27 and dropwizard-metrics version to 4.1.5 2020-04-04 16:14:57 -04:00
versions.props SOLR-14386: Update Jetty to 9.4.27 and dropwizard-metrics version to 4.1.5 2020-04-04 16:14:57 -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.

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)

Building with Ant

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

Building with Gradle

There is ongoing work (see LUCENE-9077) to switch the legacy ant-based build system to gradle. Please give it a try!

At the moment of writing, the gradle build requires precisely Java 11 (it may or may not work with newer Java versions).

To build Lucene and Solr, run (./ can be omitted on Windows):

./gradlew assemble

The command above also packages a full distribution of Solr server; the package can be located at:

solr/packaging/build/solr-*

Note that the gradle build does not create or copy binaries throughout the source repository (like ant build does) so you need to switch to the packaging output folder above; the rest of the instructions below remain identical.

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)

Gradle build and IDE support

  • IntelliJ - IntelliJ idea can import the project out of the box. Code formatting conventions should be manually adjusted.
  • Eclipse - Not tested.
  • Netbeans - Not tested.

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

Gradle build and tests

Run the following command to display an extensive help for running tests with gradle:

./gradlew helpTests

Contributing

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

Discussion and Support