Supported tags and respective `Dockerfile` links

For more information about this image and its history, please see the relevant manifest file (library/solr). This image is updated via pull requests to the docker-solr/docker-solr GitHub repo.

For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the solr/tag-details.md file in the docker-library/docs GitHub repo.

What is Apache Solr™?

Apache Solr is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more. Solr powers the search and navigation features of many of the world's largest internet sites.

Learn more on Solr's homepage and in the Solr Reference Guide.

wikipedia.org/wiki/Apache_Solr

Introduction Video

A video presentation "Introduction to docker-solr" can be found on https://www.youtube.com/watch?v=Zqst7CwAT60.

How to use this Docker image

Run Solr and index example data

To run a single Solr server:

$ docker run --name my_solr -d -p 8983:8983 -t solr

Then with a web browser go to http://localhost:8983/ to see the Admin Console (adjust the hostname for your docker host).

To use Solr, you need to create a "core", an index for your data. For example:

$ docker exec -it my_solr solr create_core -c gettingstarted

In the web UI if you click on "Core Admin" you should now see the "gettingstarted" core.

If you want to load some of the example data that is included in the container:

$ docker exec -it my_solr post -c gettingstarted example/exampledocs/manufacturers.xml

In the UI, find the "Core selector" popup menu and select the "gettingstarted" core, then select the "Query" menu item. This gives you a default search for *:* which returns all docs. Hit the "Execute Query" button, and you should see a few docs with data. Congratulations!

Single-command demo

For convenience, there is a single command that starts Solr, creates a collection called "demo", and loads sample data into it:

$ docker run --name solr_demo -d -P solr solr-demo

Loading your own data

If you want load your own data, you'll have to make it available to the container, for example by copying it into the container:

$ docker cp $HOME/mydata/mydata.xml my_solr:/opt/solr/mydata.xml
$ docker exec -it my_solr post -c gettingstarted mydata.xml

or by mounting a host directory as a volume:

$ docker run --name my_solr -d -p 8983:8983 -t -v $HOME/mydata:/opt/solr/mydata solr
$ docker exec -it my_solr solr create_core -c gettingstarted
$ docker exec -it my_solr post -c gettingstarted mydata/mydata.xml

To learn more about Solr, see the Apache Solr Reference Guide.

Creating Cores

In addition to the docker exec method explained above, you can create a core automatically at start time, in several ways.

If you run:

$ docker run -d -P solr solr-create -c mycore

the container will:

run Solr in the background, on the loopback interface
wait for it to start
run the "solr create" command with the arguments you passed
stop the background Solr
start Solr in the foreground

You can combine this with mounted volumes to pass in core configuration from your host:

$ docker run -d -P -v $PWD/myconfig:/myconfig solr solr-create -c mycore -d /myconfig

When using the solr-create command, Solr will log to the standard docker log (inspect with docker logs), and the collection creation will happen in the background and log to /opt/docker-solr/init.log.

This first way closely mirrors the manual core creation steps and uses Solr's own tools to create the core, so should be reliable.

The second way of creating a core at start time is using the solr-precreate command. This will create the core in the filesystem before running Solr. You should pass it the core name, and optionally the directory to copy the config from (this defaults to the built-in "_default" config in Solr 7, and "data_driven_schema_configs" in Solr 6). For example:

$ docker run -d -P solr solr-precreate mycore
$ docker run -d -P -v $PWD/myconfig:/myconfig solr solr-precreate mycore /myconfig

This method stores the core in an intermediate subdirectory called "mycores". This allows you to use mounted volumes:

$ mkdir mycores
$ sudo chown 8983:8983 mycores
$ docker run -d -P -v $PWD/mycores:/opt/solr/server/solr/mycores solr solr-precreate mycore

This second way is quicker, easier to monitor because it logs to the docker log, and can fail immediately if something is wrong.

The third way of creating a core at startup is to use the mechanism explained in the "Extending the image" section below.

Using Docker Compose

With Docker Compose you can create a Solr container with the index stored in a named data volume. Create a docker-compose.yml like:

version: '2'
services:
  solr:
    image: solr
    ports:
     - "8983:8983"
    volumes:
      - data:/opt/solr/server/solr/mycores
    entrypoint:
      - docker-entrypoint.sh
      - solr-precreate
      - mycore
volumes:
  data:

and just run docker-compose up.

solr.in.sh configuration

In Solr it is common to configure settings in solr.in.sh, as documented in the Solr Reference Guide.

In docker-solr you can simply pass these environment variables to the container. For example:

docker run -d -P -e SOLR_HEAP=800m solr:6.3.0

This works for Solr versions newer than 6.3.0. Older versions had some hardcoded defaults in solr.in.sh; see docs/set-heap.sh for how to modify that configuration.

Custom SOLR_HOME

In Solr, it is common to specify a custom SOLR_HOME, to store cores and configuration in a different volume. In docker-solr, you can use that with mounted volumes:

mkdir mysolrhome
sudo chown 8983:8983 mysolrhome
docker run -it -v $PWD/mysolrhome:/mysolrhome -e SOLR_HOME=/mysolrhome solr

Solr requires a solr.xml file and configsets in the SOLR_HOME, so you must provide that ahead of time. One way of doing that is to copy the default content before running Solr:

docker run -it -v $PWD/mysolrhome:/mysolrhome -e SOLR_HOME=/mysolrhome solr \
   bash -c "cp -R /opt/solr/server/solr/* /mysolrhome"
docker run -it -v $PWD/mysolrhome:/mysolrhome -e SOLR_HOME=/mysolrhome solr

or, in a single command:

docker run -it -v $PWD/mysolrhome:/mysolrhome -e SOLR_HOME=/mysolrhome solr \
   bash -c "cp -R /opt/solr/server/solr/* /mysolrhome && exec docker-entrypoint.sh solr"

As an added convenience, you can pass -e INIT_SOLR_HOME=yes to do that automatically (if SOLR_HOME is empty):

docker run -it -v $PWD/mysolrhome:/mysolrhome -e SOLR_HOME=/mysolrhome -e INIT_SOLR_HOME=yes solr

Extending the image

The docker-solr image has an extension mechanism. At run time, before starting Solr, the container will execute scripts in the /docker-entrypoint-initdb.d/ directory. You can add your own scripts there either by using mounted volumes or by using a custom Dockerfile. These scripts can for example copy a core directory with pre-loaded data for continuous integration testing, or modify the Solr configuration.

Here is a simple example. With a custom.sh script like:

#!/bin/bash
set -e
echo "this is running inside the container before Solr starts"

you can run:

$ docker run --name solr_custom1 -d -P -v $PWD/custom.sh:/docker-entrypoint-initdb.d/custom.sh solr
$ sleep 5
$ docker logs solr_custom1 | head
/opt/docker-solr/scripts/docker-entrypoint.sh: running /docker-entrypoint-initdb.d/set-heap.sh
this is running inside the container before Solr starts

Starting Solr on port 8983 from /opt/solr/server

With this extension mechanism it can be useful to see the shell commands that are being executed by the docker-entrypoint.sh script in the docker log. To do that, set an environment variable using Docker's -e VERBOSE=yes.

Distributed Solr

You can also run a distributed Solr configuration.

The recommended and most flexible way to do that is to use Docker networking. See the Can I run ZooKeeper and Solr clusters under Docker FAQ, and this example.

You can also use legacy links, see the Can I run ZooKeeper and Solr with Docker Links FAQ.

About this repository

This repository is available on github.com/docker-solr/docker-solr, and the official build is on the Docker Hub.

This repository is based on (and replaces) makuk66/docker-solr, and has been sponsored by Lucidworks.

License

Solr is licensed under the Apache License, Version 2.0.

This repository is also licensed under the Apache License, Version 2.0.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

User Feedback

Issues

Please report issues with this docker image on this Github project.

For general questions about Solr, see the Community information, in particular the solr-user mailing list.

Contributing

If you want to contribute to Solr, see the Solr Resources.

jurin-n/docker-solr

Supported tags and respective Dockerfile links