Installing Solr

Installation of Solr on Unix-compatible or Windows servers generally requires simply extracting (or, unzipping) the download package.

Please be sure to review the System Requirements before starting Solr.

Available Solr Packages

Solr is available from the Solr website. Download the latest release https://solr.apache.org/downloads.html.

There are three separate packages:

  • solr-9.6.1.tgz the full binary package, for all operating systems. This package includes all first-party Solr modules and accessories (e.g. the prometheus-exporter).

  • solr-9.6.1-slim.tgz the slim binary package, for all operating systems. This package only includes what is necessary to run Solr. Modules and accessories (e.g. the prometheus-exporter) are not included.

  • solr-9.6.1-src.tgz the package Solr source code. This is useful if you want to develop on Solr without using the official Git repository.

Two docker images are provided that utilize the full and slim binaries. Please refer to the Solr in Docker page for information on how to use them.

Preparing for Installation

When getting started with Solr, all you need to do is extract the Solr distribution archive to a directory of your choosing. This will suffice as an initial development environment, but take care not to overtax this "toy" installation before setting up your true development and production environments.

When you’ve progressed past initial evaluation of Solr, you’ll want to take care to plan your implementation. You may need to reinstall Solr on another server or make a clustered SolrCloud environment.

When you’re ready to setup Solr for a production environment, please refer to the instructions provided on the Taking Solr to Production page.

What Size Server Do I Need?

How to size your Solr installation is a complex question that relies on a number of factors, including the number and structure of documents, how many fields you intend to store, the number of users, etc.

It’s highly recommended that you spend a bit of time thinking about the factors that will impact hardware sizing for your Solr implementation. A very good blog post that discusses the issues to consider is Sizing Hardware in the Abstract: Why We Don’t have a Definitive Answer.

One thing to note when planning your installation is that a hard limit exists in Lucene for the number of documents in a single index: approximately 2.14 billion documents (2,147,483,647 to be exact). In practice, it is highly unlikely that such a large number of documents would fit and perform well in a single index, and you will likely need to distribute your index across a cluster before you ever approach this number. If you know you will exceed this number of documents in total before you’ve even started indexing, it’s best to plan your installation with SolrCloud as part of your design from the start.

Package Installation

To keep things simple for now, extract the Solr distribution archive to your local home directory:

cd ~/
tar zxf solr-9.6.1.tgz

Once extracted, you are now ready to run Solr using the instructions provided in the Starting Solr section below.

Windows includes the tar tool since Windows 10. Open a command line window and execute the above comamnd. There are also several 3rd party un-archiving tools that support .tar archives.

Directory Layout

After installing Solr, you’ll see the following directories and files within them:

bin/

This directory includes several important scripts that will make using Solr easier.

solr and solr.cmd

This is Solr’s Control Script, also known as bin/solr (*nix) / bin/solr.cmd (Windows). This script is the preferred tool to start and stop Solr. You can also create collections or cores, configure authentication, and work with configuration files when running in SolrCloud mode.

post

The Post Tool, which provides a simple command line interface for POSTing content to Solr.

solr.in.sh and solr.in.cmd

These are property files for *nix and Windows systems, respectively. System-level properties for Java, Jetty, and Solr are configured here. Many of these settings can be overridden when using bin/solr / bin/solr.cmd, but this allows you to set all the properties in one place.

install_solr_services.sh

This script is used on *nix systems to install Solr as a service. It is described in more detail in the section Taking Solr to Production.

modules/

Solr’s modules directory includes 1st-party add-ons for specialized features that enhance Solr. See the section Solr Modules for more information. This is not included in the slim distribution.

prometheus-exporter/

A standalone application, included under bin/, that montiors Solr instances and produces Prometheus metrics. See the section Monitoring with Prometheus and Grafana for more information. This is not included in the slim distribution.

docker/

This contains a Dockerfile to build a Docker image from the binary distribution, that is compatible with the official image. This directory also contains the scripts needed when using Solr inside the Docker image, under the scripts/ directory. The README.md in this directory describes how custom Solr Docker images can be built using this binary distribution. Refer to the section Solr in Docker page for information on using a Solr Docker image.

lib/

Folder where Solr will look for additional plugin jar files.

dist/

The dist directory contains the main Solr .jar files.

docs/

The docs directory includes a link to online Javadocs for Solr.

example/

The example directory includes several types of examples that demonstrate various Solr capabilities. See the section Solr Examples below for more details on what is in this directory.

licenses/

The licenses directory includes all of the licenses for 3rd party libraries used by that distribution of Solr.

server/

This directory is where the heart of the Solr application resides. A README in this directory provides a detailed overview, but here are some highlights:

  • Solr’s Admin UI & JAR files (server/solr-webapp)

  • Jetty libraries (server/lib)

  • Log files (server/logs) and log configurations (server/resources). See the section Configuring Logging for more details on how to customize Solr’s default logging.

  • Sample configsets (server/solr/configsets)

Solr Examples

The full Solr distribution includes a number of example documents and configurations to use when getting started. If you ran through the Solr Tutorials, you have already interacted with some of these files.

Here are the examples included with Solr:

exampledocs

This is a small set of simple CSV, XML, and JSON files that can be used with bin/solr post when first getting started with Solr. For more information about using bin/solr post with these files, see Post Tool.

files

The files directory provides a basic search UI for documents such as Word or PDF that you may have stored locally. See the README there for details on how to use this example.

films

The films directory includes a robust set of data about movies in three formats: CSV, XML, and JSON. See the README there for details on how to use this dataset.

Starting Solr

Solr includes a command line interface tool called bin/solr (Linux/MacOS) or bin\solr.cmd (Windows). This tool allows you to start and stop Solr, create cores and collections, configure authentication, and check the status of your system.

To use it to start Solr you can simply enter:

bin/solr start

If you are running Windows, you can start Solr by running bin\solr.cmd instead.

bin\solr.cmd start

This will start Solr in the background, listening on port 8983.

When you start Solr in the background, the script will wait to make sure Solr starts correctly before returning to the command line prompt.

All of the options for the Solr CLI are described in the section Solr Control Script Reference.

Start Solr with a Specific Bundled Example

Solr also provides a number of useful examples to help you learn about key features. You can launch the examples using the -e flag. For instance, to launch the "techproducts" example, you would do:

bin/solr start -e techproducts

Currently, the available examples you can run are: techproducts, schemaless, and cloud. See the section Running with Example Configurations for details on each example.

Getting Started with SolrCloud
Running the cloud example starts Solr in SolrCloud mode. For more information on starting Solr in SolrCloud mode, see the section Getting Started with SolrCloud.

Check if Solr is Running

If you’re not sure if Solr is running locally, you can use the status command:

bin/solr status

This will search for running Solr instances on your computer and then gather basic information about them, such as the version and memory usage.

That’s it! Solr is running. If you need convincing, use a Web browser to see the Admin Console.

http://localhost:8983/solr/

Solr’s Admin UI
Figure 1. The Solr Admin interface.

If Solr is not running, your browser will complain that it cannot connect to the server. Check your port number and try again.

Create a Core

If you did not start Solr with an example configuration, you would need to create a core in order to be able to index and search. You can do so by running:

bin/solr create -c <name>

This will create a core that uses a data-driven schema which tries to guess the correct field type when you add documents to the index.

To see all available options for creating a new core, execute:

bin/solr create -help