From caf95beb1dafe2158a3e43c863c69a4a88eff914 Mon Sep 17 00:00:00 2001 From: Andrea Aime Date: Mon, 13 Jul 2026 14:59:30 +0200 Subject: [PATCH] Align the various installation documents to jdk 17/21 and Tomcat 11 --- .../installation/prerequisites/linux.rst | 16 ++++++----- .../installation/prerequisites/macosx.rst | 28 ++++++++----------- .../installation/prerequisites/windows.rst | 11 ++++---- .../en/user/source/production/index.rst | 2 +- 4 files changed, 26 insertions(+), 31 deletions(-) diff --git a/documentation/en/user/source/installation/prerequisites/linux.rst b/documentation/en/user/source/installation/prerequisites/linux.rst index f91af2f8d9..5c0fabd3d4 100644 --- a/documentation/en/user/source/installation/prerequisites/linux.rst +++ b/documentation/en/user/source/installation/prerequisites/linux.rst @@ -7,7 +7,7 @@ Many linux distirbutions provide their own distirbution of OpenJDK, or you may i Caution is required before considering your Linux distirbution of Apache Tomcat: -* Package manager may recommend or udpate to Apache Tomcat 10 or newer (which is not supported by GeoWebCache). +* Package manager may recommend or udpate to an unsupported Apache Tomcat version. * Tomcat may be configured, in the interests of security, to restrict access to the local file system. We recommend providing your own environment as outlined below. @@ -15,18 +15,20 @@ We recommend providing your own environment as outlined below. Java Runtime Environment ------------------------ -Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 or Java 21 environment, available from `OpenJDK `__, `Adoptium `_, or provided by your OS distribution. +Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 environment, and is also tested with Java 21, available from `OpenJDK `__, `Adoptium `_, or provided by your OS distribution. See :doc:`/installation/upgrading` for compatibility table. - + Apache Tomcat ------------- -Back in your browser, navigate to ``_, find the **Tomcat 9.x** link in the **Downloads** section, and save the ``tar.gz`` file listed under **Binary Distributions / Core**. Back in your superuser shell, unpack this file as well by running ``tar xzvf /home/user/Download/apache-tomcat-9.0.106.tar.gz>`` (Make sure to use match the version numbers you downloaded name.) +GeoWebCache requires a container supporting the Jakarta EE Servlet 6.1 specification. Apache Tomcat 11 and Jetty 12 are tested; other compliant containers should work but are untested. + +Back in your browser, navigate to ``_, find the **Tomcat 11.x** link in the **Downloads** section, and save the ``tar.gz`` file listed under **Binary Distributions / Core**. Back in your superuser shell, unpack this file as well by running ``tar xzvf /home/user/Download/apache-tomcat-11.0.6.tar.gz>`` (Make sure to use match the version numbers you downloaded name.) Set the owner of the extracted directory to be your user account: ``chown apache-tomcat-a.b.c``. -Using your favorite text editor, open ``/opt/apache-tomcat-9.0.106/bin/catalina.sh``. Because we don't want to worry about system-wide settings, we will make our changes in the top of this file. Find the line that starts with ``# OS specific support`` (around line 81), and insert the following right before, making sure to input the correct path to your JRE: +Using your favorite text editor, open ``/opt/apache-tomcat-11.0.6/bin/catalina.sh``. Because we don't want to worry about system-wide settings, we will make our changes in the top of this file. Find the line that starts with ``# OS specific support`` (around line 81), and insert the following right before, making sure to input the correct path to your JRE: .. code-block:: bash @@ -40,7 +42,7 @@ Access Control If you wish to use Tomcat's web administration tool, you will need to create an account for the administrator. -Open ``/opt/apache-tomcat-9.0.106/conf/tomcat-users.xml`` in a text editor. Immediately after the line containing ````, insert:: +Open ``/opt/apache-tomcat-11.0.6/conf/tomcat-users.xml`` in a text editor. Immediately after the line containing ````, insert:: @@ -51,7 +53,7 @@ Controlling Tomcat ^^^^^^^^^^^^^^^^^^ Running as your own user, you should be able to start and stop Tomcat by using the scripts -``/opt/apache-tomcat-9.0.106/bin/startup.sh`` and ``/opt/apache-tomcat-a.b.c/bin/shutdown.sh`` +``/opt/apache-tomcat-11.0.6/bin/startup.sh`` and ``/opt/apache-tomcat-a.b.c/bin/shutdown.sh`` Verify Tomcat is running by navigating to to http://localhost:8080 (the default location of the Tomcat web interface). If Tomcat is running correctly, you should see a page congratulating you on a successful installation. diff --git a/documentation/en/user/source/installation/prerequisites/macosx.rst b/documentation/en/user/source/installation/prerequisites/macosx.rst index c577b5cc8b..c57c659c94 100644 --- a/documentation/en/user/source/installation/prerequisites/macosx.rst +++ b/documentation/en/user/source/installation/prerequisites/macosx.rst @@ -8,7 +8,7 @@ MacOS has a number of command line package managers for open source components. Java ---- -Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 or Java 21 environment. +Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 environment, and is also tested with Java 21. * Required: Java Development Kit 17 (JDK 17) @@ -34,25 +34,19 @@ See :doc:`/installation/upgrading` for compatibility table. Apache Tomcat ------------- -GeoWebCache requires Apache Tomcat 9 required for JavaEE environment. +GeoWebCache requires a container supporting the Jakarta EE Servlet 6.1 specification. Apache Tomcat 11 and Jetty 12 are tested; other compliant containers should work but are untested. -1. Navigate to `Tomcat 9 `_ **Downloads** section, and save the ``zip`` file listed under **Binary Distributions / Core**. - - * Tomcat 9 Required: GeoWebCache uses the JavaEE environment last supported in Tomcat 9. - - * Tomcat 10 Unsupported: GeoWebCache is not yet compatibile with the JakartaEE environment used by Tomcat 10 and newer. +1. Navigate to `Tomcat 11 `_ **Downloads** section, and save the ``zip`` file listed under **Binary Distributions / Core**. * SDKMan! .. code-block:: bash - - # list to determine latest Apache Tomcat 9 - sdk list tomcat 9 - - # Installing latest Tomcat 9 shown above - sdk install tomcat 9.0.102 - - # Select tomcat for use - sdk use tomcat 9.0.102 -GeoWebCache is not compatible with Apache Tomcat 10 JakarataEE environment. + # list to determine latest Apache Tomcat 11 + sdk list tomcat 11 + + # Installing latest Tomcat 11 shown above + sdk install tomcat 11.0.6 + + # Select tomcat for use + sdk use tomcat 11.0.6 diff --git a/documentation/en/user/source/installation/prerequisites/windows.rst b/documentation/en/user/source/installation/prerequisites/windows.rst index e846f3ddeb..930fe8409f 100644 --- a/documentation/en/user/source/installation/prerequisites/windows.rst +++ b/documentation/en/user/source/installation/prerequisites/windows.rst @@ -6,7 +6,7 @@ Windows Java Runtime Environment ------------------------ -Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 or Java 21 environment. +Make sure you have a Java Runtime Environment (JRE) installed on your system. GeoWebCache requires a Java 17 environment, and is also tested with Java 21. 1. Download an OpenJDK release for your platform: @@ -22,11 +22,10 @@ See :doc:`/installation/upgrading` for compatibility table. Apache Tomcat ------------- -1. Navigate to ``_, find the **Tomcat 9.x** link in the **Downloads** section, and save the ``Windows Service Installer`` file listed under **Binary Distributions / Core**. +GeoWebCache requires a container supporting the Jakarta EE Servlet 6.1 specification. Apache Tomcat 11 and Jetty 12 are tested; other compliant containers should work but are untested. + +1. Navigate to ``_, find the **Tomcat 11.x** link in the **Downloads** section, and save the ``Windows Service Installer`` file listed under **Binary Distributions / Core**. - * Tomcat 9 Required: GeoWebCache uses the JavaEE environment last supported in Tomcat 9. - - * Tomcat 10 Unsupported: GeoWebCache is not yet compatibile with the JakartaEE environment used by Tomcat 10 and newer. 2. Run this application to install Tomcat as a Windows service. After installing, use the small system tray icon. You can right click on it to ensure that it is running with the latest version of Java, and assign at least 256MB of heap memory. @@ -38,7 +37,7 @@ Access Control If you wish to use Tomcat's web administration tool, you will need to create an account for the administrator. -Do this by opening the :file:`conf\tomcat-users.xml` file in from your Tomcat Program Files directory (by default ``C:\Program Files\Apache Software Foundation\Tomcat 9.0`` in a text editor. Immediately after ```` insert: +Do this by opening the :file:`conf\tomcat-users.xml` file in from your Tomcat Program Files directory (by default ``C:\Program Files\Apache Software Foundation\Tomcat 11.0`` in a text editor. Immediately after ```` insert: .. code-block:: xml diff --git a/documentation/en/user/source/production/index.rst b/documentation/en/user/source/production/index.rst index 060fdfbaa2..470a730a05 100644 --- a/documentation/en/user/source/production/index.rst +++ b/documentation/en/user/source/production/index.rst @@ -11,7 +11,7 @@ Operating Environment Java Settings +++++++++++++ -GeoWebCache speed depends in part on the chosen Java Runtime Environment (JRE). GeoWebCache is compiled for Java 17, and is tested with both OpenJDK 17 and OpenJDK 11. JREs other than these may work correctly, but are not tested nor supported. +GeoWebCache speed depends in part on the chosen Java Runtime Environment (JRE). GeoWebCache is compiled for Java 17, and is tested with both OpenJDK 17 and OpenJDK 21. JREs other than these may work correctly, but are not tested nor supported. GeoWebCache does not need a lot of heap memory assigned to the JVM. Usually 512M is just fine if its the only web application running on the servlet container.