diff --git a/README.md b/README.md index 444d20586d92aeaac1d296747edd34e0b05415af..ecec92e394cb2c1b73194b85678d28d89b6f0afd 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,14 @@ As an application wiki, XWiki allows for the storing of structured data and the  # Table of contents + <!-- generated with pandoc -f gfm --toc -o readme-toc.md README.md --> - [Introduction](#introduction) - [How to use this image](#how-to-use-this-image) - [Pulling existing image](#pulling-existing-image) - [Using docker run](#using-docker-run) - - [Using docker-compose](#using-docker-compose) + - [Using docker-compose](#using-docker-compose) - [Using Docker Swarm](#using-docker-swarm) - [Using an external Solr service](#using-an-external-solr-service) - [Preparing Solr container](#preparing-solr-container) @@ -361,9 +362,9 @@ secrets: From the [XWiki Solr Search API documentation](http://extensions.xwiki.org/xwiki/bin/view/Extension/Solr%20Search%20API): > By default XWiki ships with an embedded Solr. This is mostly for ease of use but the embedded instance is not really recommended by the Solr team so you might want to externalize it when starting to have a wiki with a lots of pages. Solr is using a lot of memory and a standalone Solr instance is generally better in term of speed than the embedded one. It should not be much noticeable in a small wiki but if you find yourself starting to have memory issues and slow search results you should probably try to install and setup an external instance of Solr using the guide. -> +> > Also the speed of the drive where the Solr index is located can be very important because Solr/Lucene is quite filesystem intensive. For example putting it in a SSD might give a noticeable boost. -> +> > You can also find more Solr-specific performance details on https://wiki.apache.org/solr/SolrPerformanceProblems. Standalone Solr also comes with a very nice UI, along with monitoring and test tools. This image provides the configuration parameters `INDEX_HOST` and `INDEX_PORT` which are used to configure `xwiki.properties` with: