From ee73885182d620d25ff4666c98987d1919a2bd91 Mon Sep 17 00:00:00 2001 From: Richard Eckart de Castilho Date: Wed, 4 Oct 2023 21:21:41 +0200 Subject: [PATCH] No issue: Update system requirements and improve pointers to Docker-based deployment --- .../META-INF/asciidoc/admin-guide/installation.adoc | 1 + .../asciidoc/admin-guide/installation_java.adoc | 4 ++++ .../META-INF/asciidoc/common/systemrequirements.adoc | 10 +++++++--- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation.adoc b/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation.adoc index 8c8ac631e0b..94ce45b3ccb 100644 --- a/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation.adoc +++ b/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation.adoc @@ -17,6 +17,7 @@ [[sect_installation]] = Installation + You can run {product-name} on any major platform supporting Java, i.e. Linux, macOS or Windows. However, we do not provide explicit support for setting up a production-ready instance of each of these platforms. diff --git a/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation_java.adoc b/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation_java.adoc index c2f44024dc8..c26926659db 100644 --- a/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation_java.adoc +++ b/inception/inception-doc/src/main/resources/META-INF/asciidoc/admin-guide/installation_java.adoc @@ -16,6 +16,10 @@ = Install Java +NOTE: If you aim for a Docker-based deployment, it is useful for you to read the following sections to better understand + how the overall setup works. However, you will not have to install Java. If you use Docker Compose, you may also not have + to install a database. Refer to the <> section instead. + You can install a Java 11 JDK using the following commands. [source,bash] diff --git a/inception/inception-doc/src/main/resources/META-INF/asciidoc/common/systemrequirements.adoc b/inception/inception-doc/src/main/resources/META-INF/asciidoc/common/systemrequirements.adoc index 4b9237cfa75..c6417498d33 100644 --- a/inception/inception-doc/src/main/resources/META-INF/asciidoc/common/systemrequirements.adoc +++ b/inception/inception-doc/src/main/resources/META-INF/asciidoc/common/systemrequirements.adoc @@ -42,11 +42,15 @@ | Java Runtime Environment | version 11 or higher -| Apache Tomcat (or compatible) -| version 9.0 or higher (Servlet API 4.0.0) - | MariaDB Server (or compatible) | version 10.5 or higher |=== +.Requirements for a Docker-based deployment +[cols="2*"] +|=== +| Docker +| version 24 or higher (arm64 or amd64) +|=== + NOTE: link:https://mariadb.org[MariaDB] is an open source drop-in replacement for link:https://www.mysql.com[MySQL]. So generally, you can also use MySQL instead of MariaDB. Also, as far as we know, we do not use any fancy features of MariaDB 10.5 and did in fact until recently always use MySQL 5. So you can probably also use an older version of MariaDB or MySQL... but why should you? Think of all the unfixed bugs and consider also upgrading your database if you do a fresh installation of {product-name} - or use <>.