diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst index a5f71e913..c2a2ee85b 100644 --- a/Documentation/Administrator/Index.rst +++ b/Documentation/Administrator/Index.rst @@ -17,11 +17,18 @@ Administrator Manual :depth: 2 - ************ Installation ************ +Make sure you have TYPO3 and Apache Solr already running. + +a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.9.1 is the minimum version number. Make sure to pick the right file for Solr 8 or 9 respectively. +b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.9.1.jar") to the modules/ocrsearch/lib/ directory of your Apache Solr. +c. Copy the schema.xml and solrconfig.xml from Configuration/ApacheSolr/configsets/dlf/conf/ to $SOLR_HOME/configsets/dlf/ +d. Restart Solr. + + Composer Mode ============= @@ -35,7 +42,7 @@ Please run the following commands in your webroot where the TYPO3 :file:`compose .. code-block:: shell - composer require kitodo/presentation:^5 + composer require kitodo/presentation #. Install and Activate the Extension @@ -44,23 +51,6 @@ Please run the following commands in your webroot where the TYPO3 :file:`compose ./vendor/typo3 extension:activate dlf -Classic Mode -============ - -However, there are two options to install the required packages solarium/solarium and symfony/event-dispatcher in non-composer mode: - -a. Run the command :php:`composer update` within the directory of the extension. - All required packages are downloaded automatically to the vendor subdirectory. - -b. Download the required packages manually to vendor/solarium/solarium and vendor/symfony/event-dispatcher. - Please check the require sections in :file:`composer.json` of the extension, - solarium and event-dispatcher to download and install matching versions. - -After the installation of the packages in non-composer mode you have to deactivate -and (re-)activate the extension in the extension manager to trigger the TYPO3 -autoloader to rebuild the classmap. - - ******* Upgrade ******* @@ -211,24 +201,24 @@ f. Reindex all documents. This can be done by the kitodo:reindex CLI command wit Version 5.0 -> 5.1 ================== -Version 5.1 supports Solr 9 (9.4+) now, a revised configuration for Solr 8 (8.11.2) is included and support for Solr 7 and earlier is dropped. +Version 5.1 supports Apache Solr 9 (9.4+) now, a revised configuration for Apache Solr 8 (8.11+) is included and support for Apache Solr 7 and earlier is dropped. -Steps to Upgrade to Solr 9 +Steps to Upgrade to Solr 9.4+ ---------------- -a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.8.0 is the minimum version number. Make sure to pick the right file for Solr 9. -b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.8.0.jar") to the modules/ocrsearch/lib/ directory of your Solr. +a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.9.1 is the minimum version number. Make sure to pick the right file for Solr 9. +b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.9.1.jar") to the modules/ocrsearch/lib/ directory of your Solr. c. Copy the updated schema.xml and solrconfig.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/ -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`. +d. Restart Solr. +e. Reindex all documents. This can be done by the kitodo:reindex CLI command with the '-a' (all) flag. See: :ref:`reindex_collections`. -Steps to Upgrade to Solr 8.11.2 +Steps to Upgrade to Solr 8.11+ ---------------- a. Copy the updated schema.xml and solrconfig_8.11.2.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/ b. Rename solrconfig_8.11.2.xml in $SOLR_HOME/configsets/dlf/ to solrconfig.xml -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`. +c. Restart Solr. +d. 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/README.md b/README.md index abe161beb..9435aeab1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Kitodo.Presentation -Kitodo.Presentation is a feature-rich framework for building a METS- or IIIF-based digital library. It is part of the Kitodo Digital Library Suite. +Kitodo.Presentation is a feature-rich framework for building a METS- or IIIF-based digital library. It is part of the [Kitodo Digital Library Suite](https://www.kitodo.org). -Kitodo.Presentation is highly customizable through a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System [TYPO3](https://typo3.org), it integrates perfectly with your website and can easily be managed by editors. Kitodo.Presentation provides a comprehensive toolset covering all requirements for presenting digitized media. It implements international standards such as [IIIF Image API](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](https://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](https://www.loc.gov/standards/mets), [MODS](https://www.loc.gov/standards/mods), [TEI](https://www.tei-c.org), [ALTO](https://www.loc.gov/standards/alto), and can be configured to support any other descriptive XML format using simple XPath expressions. With Kitodo.Presentation you can publish digitized books, manuscripts, periodicals, newspapers, archival materials, 3D objects, audio and video. +Kitodo.Presentation is highly customizable via a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System [TYPO3](https://typo3.org), it integrates perfectly with your website and can easily be managed by editors. Kitodo.Presentation provides a comprehensive toolset covering all requirements for presenting digitized media. It implements international standards such as [IIIF Image API](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](https://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](https://www.loc.gov/standards/mets), [MODS](https://www.loc.gov/standards/mods), [TEI](https://www.tei-c.org), [ALTO](https://www.loc.gov/standards/alto), and can be configured to support any other descriptive XML format using simple XPath expressions. With Kitodo.Presentation you can publish digitized books, manuscripts, periodicals, newspapers, archival materials, 3D objects, audio and video. For a complete overview of all features, visit the [Kitodo homepage](https://www.kitodo.org/software/kitodopresentation/features). @@ -10,18 +10,7 @@ For a complete overview of all features, visit the [Kitodo homepage](https://www ## Requirements -Kitodo.Presentation requires [TYPO3](https://get.typo3.org) with [PHP](https://www.php.net). It uses [MySQL](https://www.mysql.com) or [MariaDB](https://mariadb.com) as database and [Apache Solr](https://solr.apache.org) via [Solarium](https://www.solarium-project.org) as search engine backend. - -Currently **TYPO3 11.5 ELTS** and **TYPO3 12.4 LTS** is supported with the following system requirements: - -| Component | Constraints for 11 LTS | Constraints for 12 LTS | -| ----------------------- | ---------------------- | ---------------------- | -| TYPO3 | 11.5.37+ | 12.4.16+ | -| PHP | 7.4.x - 8.3.x | 8.1.x - 8.3.x | -| MySQL | 5.7.9 - 8.0.x | 5.7.9 - 8.0.x | -| MariaDB | 10.2.7 - 10.11.x | 10.2.7 - 10.11.x | -| Apache Solr | 8.x | 8.x | -| OCR Highlighting Plugin | 0.8.x-solr78 | 0.8.x-solr78 | +Kitodo.Presentation requires [**TYPO3 v11**](https://get.typo3.org/version/11) or [**TYPO3 v12**](https://get.typo3.org/version/12). Additionally, [**Apache Solr v8.11 - v9.7**](https://solr.apache.org) with [**solr-ocrhighlighting v0.9.1+**](https://github.com/dbmdz/solr-ocrhighlighting/releases) are required as search engine backend. Application level dependencies are handled by [Composer](https://getcomposer.org) (see [composer.json](./composer.json)). @@ -33,29 +22,16 @@ Application level dependencies are handled by [Composer](https://getcomposer.org For general information and news, please visit our [website](https://www.kitodo.org). -As a system that has to meet the diverse requirements of a wide variety of institutions and the materials they want to digitise, Kitodo is a -rather complex software solution, the installation and configuration of which can be challenging, especially for users with limited IT -capacities and know-how. - -To ensure it can best advise and assist users on technical and organisational issues, the Kitodo community has established support structures -for the following typical scenarios. - -1. Users who have clearly defined questions relating to the use and development of Kitodo or Kitodo modules are well-served by the -[Kitodo mailing list](https://maillist.slub-dresden.de/mailman3/postorius/lists/kitodo-community.kitodo.org/). They will typically receive -helpful answers from the community or the Kitodo release managers within a short period of time. If this should be unsuccessful -for any reason, the Kitodo association office will address your matter to an experienced member institution. You do not need to -be a member of the association to use the mailing list. The [list archive](https://maillist.slub-dresden.de/mailman3/hyperkitty/list/kitodo-community@kitodo.org/) -provides an impression of the topics and conversations. -2. For users who occasionally need more extensive advice and possibly also on-site practical assistance for Kitodo installation, -workflow modelling, etc., the Kitodo office maintains a list of voluntary mentors. Requests can be directed to these proven experts -from various libraries by the association office. More information is available from the [association office](mailto:contact@kitodo.org). -3. For institutions that would like an initial and extensive introduction to Kitodo in the form of a product presentation or ongoing -support, in particular on-site, we are happy to provide a list of companies that to the best of our knowledge have already worked in these -fields. To obtain the company list, please also use the [association office address](mailto:contact@kitodo.org). Please bear in mind that the -association cannot provide further assistance in selecting service providers. +As a system that has to meet the diverse requirements of a wide variety of institutions and the materials they want to digitise, Kitodo is a rather complex software solution, the installation and configuration of which can be challenging, especially for users with limited IT capacities and know-how. + +To ensure it can best advise and assist users on technical and organisational issues, the Kitodo community has established support structures for the following typical scenarios. + +1. Users who have clearly defined questions relating to the use and development of Kitodo or Kitodo modules are well-served by the [Kitodo mailing list](https://maillist.slub-dresden.de/mailman3/postorius/lists/kitodo-community.kitodo.org/). They will typically receive helpful answers from the community or the Kitodo release managers within a short period of time. If this should be unsuccessful for any reason, the Kitodo association office will address your matter to an experienced member institution. You do not need to be a member of the association to use the mailing list. +2. For users who occasionally need more extensive advice and possibly also on-site practical assistance for Kitodo installation, workflow modelling, etc., the Kitodo office maintains a list of voluntary mentors. Requests can be directed to these proven experts from various libraries by the association office. More information is available from the [association office](mailto:contact@kitodo.org). +3. For institutions that would like an initial and extensive introduction to Kitodo in the form of a product presentation or ongoing support, in particular on-site, we are happy to provide a list of companies that to the best of our knowledge have already worked in these fields. To obtain the company list, please also use the [association office address](mailto:contact@kitodo.org). Please bear in mind that the association cannot provide further assistance in selecting service providers. ## Getting started -* [Extension Documentation](https://docs.typo3.org/p/kitodo/presentation/master/en-us/) +* [Extension Documentation](https://kitodo.github.io/kitodo-presentation) * [DDEV Development Environment](https://github.com/kitodo/ddev-kitodo-presentation) * [Demo Server](https://presentation-demo.kitodo.org/)