{"id":22700019,"url":"https://github.com/ub-mannheim/kitodo-presentation-docker","last_synced_at":"2025-04-13T05:52:09.742Z","repository":{"id":41104489,"uuid":"501634237","full_name":"UB-Mannheim/kitodo-presentation-docker","owner":"UB-Mannheim","description":"Docker configuration for Kitodo.Presentation","archived":false,"fork":false,"pushed_at":"2024-09-03T09:10:48.000Z","size":2633,"stargazers_count":4,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T05:51:57.541Z","etag":null,"topics":["docker","kitodo","kitodo-presentation"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UB-Mannheim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-09T11:59:44.000Z","updated_at":"2024-09-03T09:03:07.000Z","dependencies_parsed_at":"2024-01-19T10:44:47.232Z","dependency_job_id":"229c50be-3643-4648-95e7-d50bf87826a5","html_url":"https://github.com/UB-Mannheim/kitodo-presentation-docker","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UB-Mannheim%2Fkitodo-presentation-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UB-Mannheim%2Fkitodo-presentation-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UB-Mannheim%2Fkitodo-presentation-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UB-Mannheim%2Fkitodo-presentation-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UB-Mannheim","download_url":"https://codeload.github.com/UB-Mannheim/kitodo-presentation-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670505,"owners_count":21142901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","kitodo","kitodo-presentation"],"created_at":"2024-12-10T06:09:33.621Z","updated_at":"2025-04-13T05:52:09.684Z","avatar_url":"https://github.com/UB-Mannheim.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kitodo.Presentation docker\nDocker configuration for [Kitodo.Presentation](https://github.com/kitodo/kitodo-presentation).\n\n## Kitodo.Presentation\nKitodo.Presentation is a feature-rich framework for building a METS or IIIF based digital library. It is part of the Kitodo Digital Library Suite.\n\nMore Information about Kitodo.Presentation can be found on the [official Git repository](https://github.com/kitodo/kitodo-presentation).\n\n## Kitodo. Digital Library Modules\n[Kitodo](https://github.com/kitodo) is an open source software suite intended to support mass digitization projects for cultural heritage institutions. Kitodo is widely used and cooperatively maintained by major German libraries and digitization service providers. The software implements international standards such as METS, MODS, ALTO, and other formats maintained by the Library of Congress. Kitodo consists of several independent modules serving different purposes such as controlling the digitization workflow, enriching descriptive and structural metadata, and presenting the results to the public in a modern and convenient way.\n\nFor more information, visit the [Kitodo homepage](https://www.kitodo.org). You can also follow Kitodo News on [Twitter](https://twitter.com/kitodo_org).\n\n# Docker instructions\nThe Docker images were built by [Mannheim University Library](https://en.wikipedia.org/wiki/Mannheim_University_Library).\n\n### Select branch\nThere are different [branches](https://github.com/UB-Mannheim/kitodo-presentation-docker/branches) that serve to provide different installations.\nWhile the main branch always offers the latest presentation version, the others provide the following versions:\n\n#### Presentation:\n| **branch** \t| **dfg-viewer** \t| **presentation** \t| **solr** \t| **base image** \t| **last update** \t|\n|---\t|---\t|---\t|---\t|---\t|---\t|\n| [main](https://github.com/UB-Mannheim/kitodo-presentation-docker) \t| - \t| [newest](https://github.com/kitodo/kitodo-presentation/releases) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v10](https://github.com/csidirop/typo3-docker/tree/typo3-v10.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/main?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/main) \t|\n| [presentation-v4.x](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/presentation-v4.x) \t| - \t| [4.1.0](https://github.com/kitodo/kitodo-presentation/releases/tag/v4.1.0) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v10](https://github.com/csidirop/typo3-docker/tree/typo3-v10.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/presentation-v4.x?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/presentation-v4.x) \t|\n| [presentation-v3.x](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/presentation-v3.x) \t| - \t| [3.3.4](https://github.com/kitodo/kitodo-presentation/releases/tag/v3.3.4) \t| - \t| [typo3-v9](https://github.com/csidirop/typo3-docker/tree/typo3-v9.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/presentation-v3.x?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/presentation-v3.x) \t|\n\n\n#### Presentation with DFG-Viewer:\n| **branch** \t| **dfg-viewer** \t| **presentation** \t| **solr** \t| **base image** \t| **last update** \t|\n|---\t|---\t|---\t|---\t|---\t|---\t|\n| [dfg-viewer-dev](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/dfg-viewer-dev) \t| [dev-master](https://packagist.org/packages/slub/dfgviewer#dev-master) \t| [dev-master](https://packagist.org/packages/kitodo/presentation#dev-master) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v10](https://github.com/csidirop/typo3-docker/tree/typo3-v10.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/dfg-viewer-dev?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/dfg-viewer-dev) \t|\n| [dfg-viewer-6.x](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/dfg-viewer-6.x) \t| [6.0.0](https://github.com/slub/dfg-viewer/releases/tag/v6.0.0) \t| [4.1.0](https://github.com/kitodo/kitodo-presentation/releases/tag/v4.1.0) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v10](https://github.com/csidirop/typo3-docker/tree/typo3-v10.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/dfg-viewer-6.x?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/dfg-viewer-6.x) \t|\n| [dfg-viewer-6.x-ocr](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/dfg-viewer-6.x-ocr) \t| [6.x (with OCR-On-Demand)](https://github.com/UB-Mannheim/dfg-viewer/tree/6.x-ocr) \t| [4.x-ocr](https://github.com/UB-Mannheim/kitodo-presentation/tree/4.x-ocr) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v10](https://github.com/csidirop/typo3-docker/tree/typo3-v10.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/dfg-viewer-6.x-ocr?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/dfg-viewer-6.x-ocr) \t|\n| [dfg-viewer-5.3](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/dfg-viewer-5.3) \t| [5.3](https://github.com/slub/dfg-viewer/releases/tag/v5.3.0) \t| [3.3.4](https://github.com/kitodo/kitodo-presentation/releases/tag/v3.3.4) \t| - \t| [typo3-v9](https://github.com/csidirop/typo3-docker/tree/typo3-v9.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/dfg-viewer-5.3?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/dfg-viewer-5.3) \t|\n| [dfg-viewer-5.3-ocr](https://github.com/UB-Mannheim/kitodo-presentation-docker/tree/dfg-viewer-5.3-ocr) \t| [5.3 (with OCR-On-Demand)](https://github.com/UB-Mannheim/dfg-viewer/tree/5.3-ocr) \t| [3.x-ocr](https://github.com/UB-Mannheim/kitodo-presentation/tree/4.x-ocr) \t| [8.11.x](https://github.com/apache/solr-docker/tree/main/8.11) \t| [typo3-v9](https://github.com/csidirop/typo3-docker/tree/typo3-v9.x) \t| [![GitHub last commit (branch)](https://img.shields.io/github/last-commit/UB-Mannheim/kitodo-presentation-docker/dfg-viewer-5.3-ocr?label=%20)](https://github.com/UB-Mannheim/kitodo-presentation-docker/commits/dfg-viewer-5.3-ocr) \t|\n\n\u003c!-- Table created with: https://www.tablesgenerator.com/markdown_tables --\u003e\n\n### Checkout branch\n    git checkout \u003cbranchname\u003e\n\n### Change credentials\nUsernames and passwords for the database and TYPO3 backend are passed as [environment variables](https://docs.docker.com/compose/environment-variables/) and stored inside [.env-File](https://github.com/UB-Mannheim/kitodo-presentation-docker/blob/main/.env.tmpl). It is of utmost importance to change these before productive use! Also the file should only be readable for root users.\n\n### Environment variables\nThere are 13 environment variables. 8 of them that can be set in the [.env-File](https://github.com/UB-Mannheim/kitodo-presentation-docker/blob/main/.env.tmpl). First copy (or rename) `.env.tmpl` to `.env` and edit variables as needed (changing passwords like TYPO3_ADMIN_PASSWORD is recommended!).\n\nThe following table shows the default values and a short description.\n\n#### MariaDB Variables:\n|        **Name**       | **Default Value** |    **Description**    |\n|:----------------------|:-----------------:|:----------------------|\n| MARIADB_ROOT_PASSWORD |  _'rootpassword'_ | MariaDB root password |\n| MARIADB_USER          |      _typo3_      | MariaDB username      |\n| MARIADB_PASSWORD      |    _'password'_   | MariaDB user password |\n\n#### TYPO3 Variables:\n|            **Name**            | **Default Value** |                     **Description**                     |\n|:-------------------------------|:-----------------:|:--------------------------------------------------------|\n| PORT                           |        _80_       | Local port for TYPO3                                    |\n| TYPO3_ADMIN_USER               |       _test_      | TYPO3 admin username                                    |\n| TYPO3_ADMIN_PASSWORD           |    _'test1234'_   | TYPO3 admin password in ''                              |\n| TYPO3_ADDITIONAL_CONFIGURATION |      _false_      | Set to true if you want to add additional configuration |\n| PQDN                           |    _localhost_    | Partially qualified domain name (eg. _www.test.de_)     |\n| PHP_MEMORY_LIMIT               |    _512M_         | PHP memory limit                                        |\n\nThe other 5 variables are set in the docker-compose.yml and should not be changed.\n\n### solr\nApache Solr is an open-source search platform with full-text search, hit highlighting, faceted search and real-time indexing.\nTo create an additional solr container use the docker profile `with-solr` when starting the containers.\n\n### Run images:\n    docker compose up\n\nor with solr\n\n    docker compose --profile with-solr up\n\n### Ready:\nTYPO3 backend can be accessed at: http://localhost/typo3/ (of whatever you set as PQDN)\n\n\n### Run further scripts:\nYou can customize your setup by adding additional scripts! Just throw them into `/data/scripts/` and make sure they are ending with `.sh`. As soon as the entryscript has setup TYPO3 and the extensions it will run the additional scripts.   \n**Because the scripts will be executed as root they can break the system!**\n\nYou can temporally disable your scripts by changing the extension to something else like `.off`. You can even add more directories your scripts can refer to.\n\n## Code and User Feedback\nPlease file your bug reports to [issues](https://github.com/UB-Mannheim/kitodo-presentation-docker/issues).\nMake sure that you are using the latest version of the software before sending a report.\n\nThis also means making sure that old docker caches/images/containers are not present **before** making a clean install:\n- no old typo3-docker images are present: \n  - `docker images` should not show any typo3-docker image\n  - otherwise remove it with `docker rmi \u003cimage-ids\u003e`\n- no presentation-containers present:\n  - `docker container ls -a` should not show any kitodo-presentation container\n  - run `docker compose down` to \"stop containes and remove containers, networks, volumes, and images created by `docker compose up`\"\n  - run `docker rm \u003ccontainer_ID/NAME\u003e` if anything kitodo-presentation related still present\n- build without using cached layers (may take a while):\n  - `docker compose build --no-cache`\n\n##### Common practice:\n1. `docker compose down` or `docker compose --profile with-solr down`\n2. `docker compose up --build` or `docker compose --profile with-solr up --build`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fub-mannheim%2Fkitodo-presentation-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fub-mannheim%2Fkitodo-presentation-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fub-mannheim%2Fkitodo-presentation-docker/lists"}