search

kitodo / kitodo-production

Kitodo.Production is a workflow management tool for mass digitization and is part of the Kitodo Digital Library Suite.
http://www.kitodo.org/software/kitodoproduction/
GNU General Public License v3.0
64 stars 63 forks source link

[FUND] Preconfigured, easy to install package for testing and documentation purposes #5968

Open Erikmitk opened 9 months ago

Erikmitk commented 9 months ago

Description

To facilitate software testing for new releases, we need a flexible test environment. This environment should include yet-to-be-defined sets of diverse sample projects, processes, workflows, configurations and users. It must be reproducible, preconfigured, and easy to install. Additionally, it should support dynamic creation with parametrizable software versions, allowing configuration of specific development versions of Kitodo.Production such as tags or branches. Furthermore, comprehensive documentation is essential to ensure the usefulness of this environment.

Related Issues

A prerequisite for this is the definition of baseline functionality and standardized sets of sample data by the Community Board.

Expected Benefits of this Development

By establishing a standardized environment, developers and release managers can communicate changes more effectively. Having a preconfigured version of Kitodo.Production simplifies testing for those new to the software. This benefits developers, release managers, and anyone looking to explore or test Kitodo.Production.

In the long run, this environment could serve as the foundation for testing Kitodo.Production's core features. By automating testing against this baseline, it cuts down on the need for manual testing. This means institutions can concentrate on their own customizations, confident that the established environment always works reliably. Moreover, the documentation provided for users can be done via this environment, ensuring seamless integration of software and documentation independent from the institution that is using it.

Estimated Costs and Complexity

I estimate the cost as medium as there are already unofficial prototypical solutions (https://github.com/slub/kitodo-production-docker).

Erikmitk commented 9 months ago

@solth Can you change the label to 2024? I used the issue template and that contains the wrong year. :)

solth commented 8 months ago

Votes: 2

stweil commented 4 months ago

@matthias-ronge, @Kathrin-Huber, you wrote the latest Installation instructions for Kitodo.Production 3.4 (German version) . Meanwhile we have Kitodo.Production 3.6. Are there also newer instructions available?

I must admit that I was not able to install the current version from Git master. The existing instructions don't cover important aspects (for example which Linux distribution in which release should be used). I guessed from the GitHub action that Ubuntu 20.04 should be the best (or only?) choice, but even with this old release I get lots of warnings (also visible in the action's log) or even errors when I run the Maven build.

BartChris commented 4 months ago

Ubuntu 22.04 should work well, as it includes out-of-the-box support for Tomcat 9 and Java 11. Ubuntu 24 only has Tomcat 10 so it does not work out of the box. I am not sure wether LDAP for Samba is still supported on Ubuntu 22 (https://github.com/kitodo/kitodo-production/issues/4646), but i suppose it is.

Edit: Smbv1 support on newer kernels seems to be really problematic, so i have no idea if one can rely on that. https://bugzilla.kernel.org/show_bug.cgi?id=215375

matthias-ronge commented 3 months ago

Are there also newer instructions available?

Only what is in the wiki. But only a few paths with the numbers have changed. I am not aware of any major changes.