Apache Lucene open-source search software
Go to file
Lu Xugang 9837bc4a4d
LUCENE-9590: Add javadoc for Lucene86PointsFormat class (#2194)
to Lucene's Confluence.
* also corrected some trivial errors in javadocs & comments
2021-02-11 15:25:28 -05:00
.github SOLR-15075: Solr docker gradle improvements (#2197) 2021-01-26 10:22:50 -05:00
.muse SOLR-14883 Add a Muse (Continuous assurance platform) configuration (#1901) 2020-09-23 17:42:19 -07:00
buildSrc LUCENE-9266 remove gradle wrapper jar from source 2020-04-02 11:30:01 -05:00
dev-docs Adding dev-docs around the use of Git Worktree. (#1899) 2020-09-21 14:23:24 -04:00
dev-tools LUCENE-9747: dodge javadoc reporter NPE bug on Java 11. (#2337) 2021-02-09 21:47:38 +01:00
gradle LUCENE-9727: build side support for running Hunspell tests. (#2313) 2021-02-08 10:50:25 +01:00
help SOLR-15075: Solr docker gradle improvements (#2197) 2021-01-26 10:22:50 -05:00
lucene LUCENE-9590: Add javadoc for Lucene86PointsFormat class (#2194) 2021-02-11 15:25:28 -05:00
solr SOLR-15145: solr.storeBaseUrl feature flag introduced in 8.8.1 should default to false for 9.x 2021-02-11 12:50:29 -07:00
.asf.yaml Configure notifications. 2020-04-22 15:23:13 +02:00
.dir-locals.el LUCENE-9322: Add Lucene90 codec, including VectorFormat 2020-10-18 07:49:36 -04:00
.git-blame-ignore-revs LUCENE-9570: code reformatting [record rev]. 2021-01-05 13:44:42 +01:00
.gitattributes LUCENE-9077: make git always keep .gradle files with LF EOLs. 2020-04-09 13:55:16 +02:00
.gitignore .gitignore clean up (#1993) 2020-10-24 11:09:55 -04: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 LUCENE-9509: fix generating documentation command for Solr 2020-09-07 20:48:24 +09:00
build.gradle SOLR-15075: Solr docker gradle improvements (#2197) 2021-01-26 10:22:50 -05:00
gradlew Gradle hotfix in preparation for Jenkins: Fix for whitespace in directory violations 2020-08-23 17:51:11 +02:00
gradlew.bat Gradle hotfix in preparation for Jenkins: Fix for whitespace in directory violations 2020-08-23 17:51:11 +02:00
settings.gradle SOLR-14067: v4 Create /contrib/scripting module with ScriptingUpdateProcessor (#2257) 2021-01-29 12:27:36 -05:00
versions.lock LUCENE-9322: Move old field infos format to backwards-codecs. (#2245) 2021-01-26 10:14:55 -08:00
versions.props SOLR-14995 Update Jetty to latest version 2020-11-11 13:27:49 -08: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 in Java and 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 with Gradle

Building Lucene

See lucene/BUILD.md.

Building Solr

Firstly, you need to set up your development environment (OpenJDK 11 or greater).

We'll assume that you know how to get and set up the JDK - if you don't, then we suggest starting at https://www.oracle.com/java/ and learning more about Java, before returning to this README. Solr runs with Java 11 and later.

As of 9.0, Lucene/Solr uses Gradle as the build system. Ant build support has been removed.

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

./gradlew assemble

NOTE: DO NOT use gradle command that is already installed on your machine (unless you know what you'll do). The "gradle wrapper" (gradlew) does the job - downloads the correct version of it, setups necessary configurations.

The first time you run Gradle, it will create a file "gradle.properties" that contains machine-specific settings. Normally you can use this file as-is, but it can be modified if necessary.

The command above 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 so you need to switch to the packaging output folder above; the rest of the instructions below remain identical. The packaging directory is rewritten on each build.

For development, especially when you have created test indexes etc, use the ./gradlew dev task which will copy binaries to ./solr/packaging/build/dev but only overwrite the binaries which will preserve your test setup.

If you want to build the documentation, type ./gradlew -p solr documentation.

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.

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.

Gradle build and tests

./gradlew assemble will build a runnable Solr as noted above.

./gradlew check will assemble Lucene/Solr and run all validation tasks unit tests.

./gradlew help will print a list of help commands for high-level tasks. One of these is helpAnt that shows the gradle tasks corresponding to ant targets you may be familiar with.

Contributing

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

Discussion and Support