Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 2.87 KB

BUILD.md

File metadata and controls

84 lines (55 loc) · 2.87 KB
Raw

Lucene Build Instructions

Basic steps:

  1. Install OpenJDK 11 (or greater)
  2. Download Lucene/Solr from Apache and unpack it
  3. Connect to the top-level of your installation (parent of the lucene top-level directory)
  4. Install JavaCC (optional)
  5. Run gradle

Step 0) 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. Lucene runs with Java 11 and later.

Lucene uses Gradle for build control.

NOTE: When Solr moves to a Top Level Project, it will no longer be necessary to download Solr to build Lucene. You can track progress at: https://issues.apache.org/jira/browse/SOLR-14497

NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases still use Ant.

Step 1) Checkout/Download Lucene source code

We'll assume you already did this, or you wouldn't be reading this file. However, you might have received this file by some alternate route, or you might have an incomplete copy of the Lucene, so: you can directly checkout the source code from GitHub:

https://github.com/apache/lucene-solr

Or Lucene source archives at particlar releases are available as part of Solr downloads:

https://lucene.apache.org/solr/downloads.html

Download either a zip or a tarred/gzipped version of the archive, and uncompress it into a directory of your choice.

Step 2) Change directory (cd) into the top-level directory of the source tree

The parent directory for both Lucene and Solr contains the base configuration file for the combined build. By default, you do not need to change any of the settings in this file, but you do need to run Gradle from this location so it knows where to find the necessary configurations.

Step 4) Run Gradle

Assuming you can exectue "./gradlew help" should show you the main tasks that can be executed to show help sub-topics.

If you want to build Lucene independent of Solr, type:

./gradlew -p lucene 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.

If you want to build the documentation, type:

./gradlew -p lucene documentation

For further information on Lucene, go to:

https://lucene.apache.org/

Please join the Lucene-User mailing list by visiting this site:

https://lucene.apache.org/core/discussion.html

Please post suggestions, questions, corrections or additions to this document to the lucene-user mailing list.