Update installation instruction for the ocr highlighting plugin

kitodo · Oct 1, 2021 · b3ac732 · b3ac732
1 parent b3f9469
commit b3ac732
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 23 deletions.
diff --git a/Configuration/ApacheSolr/README.txt b/Configuration/ApacheSolr/README.txt
@@ -6,18 +6,5 @@ This is just a configset for Apache Solr.
 Installation instructions
 -------------------------
 
-See also: https://wiki.apache.org/solr/SolrTomcat
-
-1. Make sure you have Apache Solr 7.4 up and running. Download Solr
-    from http://lucene.apache.org/solr/. Other versions since 5.0 should be possible but are not tested.
-
-2. Copy the Configuration/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/dlf.
-
-3. Using basic authentication is optional but recommended. The documentation is available here:
-    https://lucene.apache.org/solr/guide/7_4/basic-authentication-plugin.html
-
-Update instructions
--------------------
-
-When updating an existing Solr instance for Kitodo.Presentation follow the
-above steps.
+Please follow the Solr installation instruction in the official
+Kitodo.Presentation documentation at https://docs.typo3.org/p/kitodo/presentation/master/en-us/Configuration/Index.html#solr-installation.
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -155,14 +155,31 @@ This extension doesn't include Solr, but just a prepared configuration set.
 To setup Apache Solr, perform the following steps:
 
 1. Make sure you have Apache Solr 7.7 or 8.8 and running.
-    Download Solr from https://solr.apache.org/downloads.html.
-    Other versions may work but are not tested.
 
-2. Copy the lib/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/dlf.
+   Download Solr from https://solr.apache.org/downloads.html.
+   Other versions may work but are not tested.
 
-3. Using basic authentication is optional but recommended.
-    The documentation is available here:
-    https://lucene.apache.org/solr/guide/7_4/basic-authentication-plugin.html
+2. Copy the config set to your solr home
+
+.. code-block:: bash
+
+      cp -r dlf/Configuration/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/
+
+3. Get the Solr OCR Highlighting plugin and put it into contrib directory.
+
+   The plugin is available on GitHub (https://github.com/dbmdz/solr-ocrhighlighting/releases).
+   The documentation can be found here: https://dbmdz.github.io/solr-ocrhighlighting/.
+
+   The Solr OCR Highlighting plugin is required for full text search as of Kitodo.Presentation 3.3.
+
+.. code-block:: bash
+
+      cp -r dlf/Configuration/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/
+
+4. Using basic authentication is optional but recommended.
+
+   The documentation is available here:
+   https://solr.apache.org/guide/8_8/basic-authentication-plugin.html
 
 
 .. _configuration-typoscript:
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ Currently **TYPO3 9.5 LTS** is supported with the following system requirements:
 | MySQL       | 5.7.x                 |
 | MariaDB     | 10.2.x - 10.3.x       |
 | Apache Solr | 7.x - 8.x             |
+| OCR Highlighting Plugin | 0.7.1     |
 
 Application level dependencies are handled by [Composer](https://getcomposer.org) (see [composer.json](./composer.json)).
 
@@ -41,8 +42,6 @@ Kitodo. Key to digital objects
 
 To get more information, visit the [Kitodo homepage](https://www.kitodo.org). You can also follow Kitodo News on [Twitter](https://twitter.com/kitodo_org).
 
-[![Join the Gitter chat!](https://badges.gitter.im/Kitodo/Presentation.svg)](https://gitter.im/Kitodo/Presentation)
-
 ---
 
 Kitodo was formerly known as Goobi. Older releases can be found on [Launchpad](https://launchpad.net/goobi-presentation).