Merge pull request #691 from albig/add-upgrade-documentation

Add some more documentation about upgrading to Version 3.3
kitodo · Oct 13, 2021 · 4f3247e · 4f3247e
2 parents d051efc + 88de931
commit 4f3247e
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst
@@ -61,6 +61,32 @@ and (re-)activate the extension in the extension manager to trigger the TYPO3
 autoloader to rebuild the classmap.
 
 
+*******
+Upgrade
+*******
+
+This section contains version specific instructions on upgrading an existing Kitodo.Presentation installation.
+
+Version 3.2 -> 3.3
+==================
+
+Version 3.3 introduce the usage of the OCR Highlighting Plugin for Solr. The plugin can be found at
+GitHub: https://github.com/dbmdz/solr-ocrhighlighting. This plugin is now mandatory if you are using the full texts feature.
+
+Please note: The full text is stored in Solr index in a XML format (`MiniOCR <https://dbmdz.github.io/solr-ocrhighlighting/formats/#miniocr>`_).
+This will rise the demand for storage space. You should therefore monitor the disc usage during reindexing.
+
+Steps to Upgrade
+----------------
+
+a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.7.1 is the minimum version number.
+b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.7.1.jar") to the contrib/ocrsearch/lib/ directory of your Solr.
+c. Copy the updated schema.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/
+d. Copy the schema.xml from EXT:dlf/Configuration/ApacheSolr/configsets/dlf/conf/ to all of your Solr cores. E.g. $SOLR_HOME/data/dlfCore0/conf/
+e. Restart Solr.
+f. Reindex all documents. This can be done by the kitodo:reindex CLI command with the '-a' (all) flag. See: :ref:`reindex_collections`.
+
+
 *******
 Logging
 *******

diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -165,7 +165,7 @@ To setup Apache Solr, perform the following steps:
 
       cp -r dlf/Configuration/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/
 
-3. Get the Solr OCR Highlighting plugin and put it into contrib directory.
+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/.
@@ -174,7 +174,7 @@ To setup Apache Solr, perform the following steps:
 
 .. code-block:: bash
 
-      cp -r dlf/Configuration/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/
+      cp solr-ocrhighlighting-0.7.1.jar to contrib/ocrsearch/lib/
 
 4. Using basic authentication is optional but recommended.
 

diff --git a/Documentation/User/Index.rst b/Documentation/User/Index.rst
@@ -120,6 +120,8 @@ The command `kitodo:index` is used for indexing a single document::
        Show processed documents uid and location with indexing parameters.
    :Example:
 
+.. _reindex_collections:
+
 Reindex collections
 -------------------