[FEATURE] Workflow and functionalities to provide DFG-Viewer as a Docker image and use it

[markusweigelt]

• Dockerfile and resources to build the Docker Image
• Docker Compose file to run the DFG-Viewer image and database
• GitHub Workflow to build, test, and publish the DFG-Viewer Docker Image to the GitHub Container Repository

When starting the Docker Image, the following steps run automatically:

1. TYPO3 12 will be installed.
2. Extensions DFG-Viewer (Branch update-typo12), Kitodo.Presentation (dev-master), and SLUB Digital Collection (Branch update-typo12) will be installed.
3. Some configurations are applied.

The initial startup may take about a minute.

The DFG-Viewer instance can then be accessed via localhost, unless otherwise configured.

For more informations please check the README. Let me know if you need further assistance!

[stweil]

Many steps are similar to my setup, but some are different. Maybe we can find a common optimum.

[markusweigelt]

The basic setup for installing the system is similar to Martin Helmich's approach. Unfortunately, this Dockerfile is based only on a non-Composer installation. Otherwise, I would have used this Docker image as a base. Some of the currently published releases of DFG-Viewer or Kitodo.Presentation in the TER did not include a vendor folder and could not be installed in this environment over ZIP file. Therefore, I found the use of Composer to be essential.

The primary goal is to create a production-ready image. This means all components for development, such as Git, are not installed, or features like debugging are disabled.

Currently, the image is still being built based on the branches for TYPO3 12. Once these are merged, the GitHub workflow could be set to the main repositories.

For development, I recommend using the repository slub/ddev-dfgviewer, which will soon be updated with the branch update-and-adjustments.
Alternatively, we can certainly create certain options here to override or adjust the configuration (in case the slub/ddev-dfgviewer repository is no longer maintained after my project).

[csidirop]

Don't we already have a way to setup presentation (and dfg-viewer) via Docker: https://github.com/UB-Mannheim/kitodo-presentation-docker ?

[stweil]

That's right, thanks for the reminder. And we also own https://hub.docker.com/u/kitodo, so we could publish the Docker image there.

[markusweigelt]

Don't we already have a way to setup presentation (and dfg-viewer) via Docker: https://github.com/UB-Mannheim/kitodo-presentation-docker ?

It is part of my project to provide the DFG Viewer as an offical image, ideally as part of the DFG Viewer repository.

According to the project and the project proposal, there is a demand for this, and of course, there are institution-specific implementations. If UB Mannheim is providing the official image for the DFG-Viewer and Kitodo.Presentation, then this has apparently not been communicated accordingly. However, that is not my responsibility.

[markusweigelt]

That's right, thanks for the reminder. And we also own https://hub.docker.com/u/kitodo, so we could publish the Docker image there.

The DFG Viewer is not part of the Kitodo association. Perhaps communication with SLUB should be initiated first, for example with @beatrycze-volk or @sebastian-meyer, to avoid creating faits accomplis and instead develop a collaborative and sustainable solution. I think the GitHub container repository is the right place to provide an official image.

For further points regarding these political topics, a discussion should be opened elsewhere. I do not think the comment section of this PR is suitable for that purpose.

[stweil]

@markusweigelt, but you know that Christos did his DFG Viewer work in a common DFG project with SLUB and UB Braunschweig, so there was intensive communication?

[markusweigelt]

@stweil Yes, I was aware that he extended the DFG Viewer in the OCR-D project. However, I have no knowledge of which project he is currently working on, particularly in relation to a Docker image, and I had no information on this either.

[stweil]

The Kitodo / DFG Viewer Docker image was part of his project work in the past. Although the project was officially finished, there remain open tasks: update for recent TYPO3, then integration of the implemented function (OCR on demand) into the official repositories. That's not part of a current project, but we try do do it nevertheless.

[stweil]

The Kitodo organisation on Docker Hub is a different issue. I created it very early for a Docker image of Kitodo.Production. So there is still no Docker image for Kitodo.Presentation (with DFG Viewer as example) on Docker Hub. But it might be a good place for such an image as soon as it exists officially.

[markusweigelt]

There is no official information that I could find, e.g., on the DFG Viewer website, TYPO3 extension documentation, README.md, or DEVELOPMENT.md, indicating that an effort towards an official image already exists or is available for older versions.