diff --git a/solr/README-short.txt b/solr/README-short.txt new file mode 100644 index 000000000..3ae4ad401 --- /dev/null +++ b/solr/README-short.txt @@ -0,0 +1 @@ +Solr is the popular, blazing-fast, open source enterprise search platform built on Apache Lucene™. diff --git a/solr/README.md b/solr/README.md new file mode 100644 index 000000000..fae5e7b1f --- /dev/null +++ b/solr/README.md @@ -0,0 +1,119 @@ +# Supported tags and respective `Dockerfile` links + +- [`5.3.0`, `5.3`, `5`, `latest` (*5.3/Dockerfile*)](https://github.com/docker-solr/docker-solr/blob/39b20393652644fc5e0fe2a34d4bda1c257f8ed6/5.3/Dockerfile) + +For more information about this image and its history, please see [the relevant manifest file (`library/solr`)](https://github.com/docker-library/official-images/blob/master/library/solr). This image is updated via pull requests to [the `docker-solr/docker-solr` GitHub repo](https://github.com/docker-solr/docker-solr). + +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](https://github.com/docker-library/docs/blob/master/solr/tag-details.md) in [the `docker-library/docs` GitHub repo](https://github.com/docker-library/docs). + +# What is Solr? +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 [Apache Solr homepage](http://lucene.apache.org/solr/) and in the [Apache Solr Reference Guide](https://www.apache.org/dyn/closer.cgi/lucene/solr/ref-guide/). + +> [wikipedia.org/wiki/Apache_Solr](https://en.wikipedia.org/wiki/Apache_Solr) + +![logo](https://raw.githubusercontent.com/docker-library/docs/master/solr/logo.png) + +# How to use this Docker image + +To run a single Solr server: + + SOLR_CONTAINER=$(docker run -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 --user=solr $SOLR_CONTAINER bin/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 example data: + + docker exec -it --user=solr $SOLR_CONTAINER bin/post -c gettingstarted example/films/films.json + +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 film data. Congratulations! + +To learn more about Solr, see the [Apache Solr Reference Guide](https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide). + +## Single-container SolrCloud + +To simulate a distributed Solr configuration ("SolrCloud" mode) on a single container with 2 nodes in separate JVMs, run the "cloud" example: + + docker run -d -p 8983:8983 -p 7574:7574 solr \ + /bin/bash -c "/opt/solr/bin/solr -e cloud -noprompt; while true ; do sleep 3600; done" + +This will take a minute or so to start. You can follow along with `docker logs -f CONTAINER`. + +## Distributed Solr + +You can also run a distributed Solr configuration, with Solr nodes in separate containers, sharing a single ZooKeeper server: + +Run ZooKeeper, and define a name so we can link to it: + + docker run --name zookeeper -d -p 2181:2181 -p 2888:2888 -p 3888:3888 jplock/zookeeper + +Run two Solr nodes, linked to the zookeeper container: + + docker run --name solr1 --link zookeeper:ZK -d -p 8983:8983 \ + solr \ + bash -c '/opt/solr/bin/solr start -f -z $ZK_PORT_2181_TCP_ADDR:$ZK_PORT_2181_TCP_PORT' + + docker run --name solr2 --link zookeeper:ZK -d -p 8984:8983 \ + solr \ + bash -c '/opt/solr/bin/solr start -f -z $ZK_PORT_2181_TCP_ADDR:$ZK_PORT_2181_TCP_PORT' + +Create a collection: + + docker exec -i -t solr1 /opt/solr/bin/solr create_collection \ + -c collection1 -shards 2 -p 8983 + +Then go to `http://localhost:8983/solr/#/~cloud` (adjust the hostname for your docker host) to see the two shards and Solr nodes. + +# About this repository + +This repository is available on [github.com/docker-solr/docker-solr](https://github.com/docker-solr/docker-solr), and the official build is on the [Docker Hub](https://hub.docker.com/u/solr/). + +This repository is based on (and replaces) `makuk66/docker-solr`, and has been sponsored by [Lucidworks](http://www.lucidworks.com/). + +# License + +Solr is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +This repository is also licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +Copyright 2015 Martijn Koster + +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. + +# Supported Docker versions + +This image is officially supported on Docker version 1.8.2. + +Support for older versions (down to 1.0) is provided on a best-effort basis. + +# User Feedback + +## Issues + +Please report issues with this docker image on this [Github project](https://github.com/docker-solr/docker-solr). + +For general questions about Solr, see the [Community information](http://lucene.apache.org/solr/resources.html#community), +in particular the solr-user mailing list. + +## Contributing + +If you want to contribute to Solr, see the [Solr Resources](http://lucene.apache.org/solr/resources.html#community). diff --git a/solr/content.md b/solr/content.md new file mode 100644 index 000000000..3bded7210 --- /dev/null +++ b/solr/content.md @@ -0,0 +1,72 @@ +# What is Solr? +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 [Apache Solr homepage](http://lucene.apache.org/solr/) and in the [Apache Solr Reference Guide](https://www.apache.org/dyn/closer.cgi/lucene/solr/ref-guide/). + +> [wikipedia.org/wiki/Apache_Solr](https://en.wikipedia.org/wiki/Apache_Solr) + +%%LOGO%% + +# How to use this Docker image + +To run a single Solr server: + + SOLR_CONTAINER=$(docker run -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 --user=solr $SOLR_CONTAINER bin/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 example data: + + docker exec -it --user=solr $SOLR_CONTAINER bin/post -c gettingstarted example/films/films.json + +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 film data. Congratulations! + +To learn more about Solr, see the [Apache Solr Reference Guide](https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide). + +## Single-container SolrCloud + +To simulate a distributed Solr configuration ("SolrCloud" mode) on a single container with 2 nodes in separate JVMs, run the "cloud" example: + + docker run -d -p 8983:8983 -p 7574:7574 solr \ + /bin/bash -c "/opt/solr/bin/solr -e cloud -noprompt; while true ; do sleep 3600; done" + +This will take a minute or so to start. You can follow along with `docker logs -f CONTAINER`. + +## Distributed Solr + +You can also run a distributed Solr configuration, with Solr nodes in separate containers, sharing a single ZooKeeper server: + +Run ZooKeeper, and define a name so we can link to it: + + docker run --name zookeeper -d -p 2181:2181 -p 2888:2888 -p 3888:3888 jplock/zookeeper + +Run two Solr nodes, linked to the zookeeper container: + + docker run --name solr1 --link zookeeper:ZK -d -p 8983:8983 \ + solr \ + bash -c '/opt/solr/bin/solr start -f -z $ZK_PORT_2181_TCP_ADDR:$ZK_PORT_2181_TCP_PORT' + + docker run --name solr2 --link zookeeper:ZK -d -p 8984:8983 \ + solr \ + bash -c '/opt/solr/bin/solr start -f -z $ZK_PORT_2181_TCP_ADDR:$ZK_PORT_2181_TCP_PORT' + +Create a collection: + + docker exec -i -t solr1 /opt/solr/bin/solr create_collection \ + -c collection1 -shards 2 -p 8983 + +Then go to `http://localhost:8983/solr/#/~cloud` (adjust the hostname for your docker host) to see the two shards and Solr nodes. + +# About this repository + +This repository is available on [github.com/docker-solr/docker-solr](https://github.com/docker-solr/docker-solr), and the official build is on the [Docker Hub](https://hub.docker.com/u/solr/). + +This repository is based on (and replaces) `makuk66/docker-solr`, and has been sponsored by [Lucidworks](http://www.lucidworks.com/). diff --git a/solr/license.md b/solr/license.md new file mode 100644 index 000000000..e6ba3f552 --- /dev/null +++ b/solr/license.md @@ -0,0 +1,17 @@ +Solr is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +This repository is also licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +Copyright 2015 Martijn Koster + +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. diff --git a/solr/logo.png b/solr/logo.png new file mode 100644 index 000000000..517656719 Binary files /dev/null and b/solr/logo.png differ diff --git a/solr/tag-details.md b/solr/tag-details.md new file mode 100644 index 000000000..b98f576e5 --- /dev/null +++ b/solr/tag-details.md @@ -0,0 +1 @@ + diff --git a/solr/user-feedback.md b/solr/user-feedback.md new file mode 100644 index 000000000..52b187377 --- /dev/null +++ b/solr/user-feedback.md @@ -0,0 +1,10 @@ +## Issues + +Please report issues with this docker image on this [Github project](https://github.com/docker-solr/docker-solr). + +For general questions about Solr, see the [Community information](http://lucene.apache.org/solr/resources.html#community), +in particular the solr-user mailing list. + +## Contributing + +If you want to contribute to Solr, see the [Solr Resources](http://lucene.apache.org/solr/resources.html#community). diff --git a/update.sh b/update.sh index 5dadefd91..06868c652 100755 --- a/update.sh +++ b/update.sh @@ -62,6 +62,7 @@ declare -A otherRepos=( [rocket.chat]='https://github.com/RocketChat/Docker.Official.Image' [ros]='https://github.com/osrf/docker_images' [sentry]='https://github.com/getsentry/docker-sentry' + [solr]='https://github.com/docker-solr/solr' [sonarqube]='https://github.com/SonarSource/docker-sonarqube' [swarm]='https://github.com/docker/swarm-library-image' [thrift]='https://github.com/ahawkins/docker-thrift'