Tomcat 10.1.x on Windows

Apache Tomcat is an open-source implementation of the Java Servlet, JavaServer Pages (JSP), and WebSocket technologies. It is widely used to deploy Java-based web applications. This document provides a detailed, step-by-step process for installing and configuring both single-instance and multi-instance Tomcat setups on a Windows machine for OvalEdge deployment.

Pre-requisites

Before proceeding with the installation, ensure the following requirements are met:

  • Windows OS (Windows 10 or later recommended)

  • Administrator privileges

  • Java 17 installed and configured

  • Ensure the JAVA_HOME environment variable is set

  • Refer to the Java Installation Guide if Java is not configured

Single Tomcat Installation

  • Prepare Directory Structure

    Create a base folder, e.g., C:\ovaledge, to store all required files.

  • Inside this folder, create subfolders:

    • temp

    • extprop

    • Third_party_jars

  • Place Required Files

    • Configuration Files: Place oasis.properties and log4j.properties inside the extprop folder (provided by GCS team).

    • JAR Files: Place required third-party JARs in the Third_party_jars folder.

  • Download and Extract Tomcat

    • Download Apache Tomcat (ZIP package).

    • Extract contents under C:\ovaledge.

  • Deploy WAR File

    • Navigate to the webapps folder inside the Tomcat directory.

    • Place the ovaledge.war file (provided by GCS team).

  • Install Tomcat as a Windows Service

    • Navigate to the bin folder inside Tomcat and open Command Prompt.

    • Run the command:

      service.bat install tomcat
  • Configure Java Options for Tomcat

    • Open Tomcat service properties:

      tomcat10w.exe //ES//tomcat
    • Go to the Java tab and add:

      -DOVALEDGE_SECURITY_TYPE=db
      -Dext.properties.dir=file:C:\ovaledge\extprop\
      -Dlog4j.configuration=file:C:\ovaledge\extprop\log4j.properties
      -DOVALEDGE_ENCRYPT_DECRYPT_KEY=client_input
      --add-opens=java.base/jdk.internal.loader=ALL-UNNAMED
      --add-opens=jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED
      --add-opens=java.base/java.net=ALL-UNNAMED
    • Confirm with GCS/DevOps team:

      • ext.properties.dir path

      • log4j.configuration path

      • Encryption key value

      • Java heap settings (per VM specification)

  • Update oasis.properties

    • Configure:

      • Database connection details

      • Elasticsearch configuration (if applicable)

      • Path to third-party JAR files

  • Start Tomcat Service

    • Open Services from Windows Start menu.

    • Locate and start the Tomcat service.

    • In Properties:

      • Set Startup type → Automatic (Delayed Start)

      • Update Log On credentials as required and click OK.

Multi-Tomcat Installation (UI + Job)

For multi-instance setups, two Tomcats are configured:

  • Two Tomcats are configured:

    • tomcatui → User Interface (UI)

    • tomcatjob → Job Processing

  • Repeat Initial Setup

    • Follow Single Tomcat Installation steps until WAR deployment.

  • Duplicate Tomcat Directory

    • Create two copies of the Tomcat directory.

    • Rename:

      • One to tomcatui

      • One to tomcatjob

  • Update Ports for tomcatjob

    • Navigate to tomcatjob\conf\server.xml.

    • Modify:

      • Shutdown port → 8005 → 8006

      • HTTP port → 8080 → 8081

  • Install and Configure tomcatui Service

    • Navigate to tomcatui\bin and open Command Prompt:

      service.bat install tomcatui

      tomcat10w.exe //ES//tomcatui
    • In the Java tab, add:

      -DOVALEDGE_SECURITY_TYPE=db
      -Dpod.type=ovaledge-ui-deployment
      -Dext.properties.dir=file:C:\ovaledge\extprop\
      -Dlog4j.configuration=file:C:\ovaledge\extprop\log4j.properties
      -DOVALEDGE_ENCRYPT_DECRYPT_KEY=client_input
      --add-opens=java.base/jdk.internal.loader=ALL-UNNAMED
      --add-opens=jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED
      --add-opens=java.base/java.net=ALL-UNNAMED
  • Install and Configure tomcatjob Service

    • Navigate to tomcatjob\bin and open Command Prompt:

      service.bat install tomcatjob

      tomcat10w.exe //ES//tomcatjob
    • In the Java tab, add:

      -DOVALEDGE_SECURITY_TYPE=db
      -Dpod.type=ovaledge-job-deployment
      -Dext.properties.dir=file:C:\ovaledge\extprop\
      -Dlog4j.configuration=file:C:\ovaledge\extprop\log4j.properties
      -DOVALEDGE_ENCRYPT_DECRYPT_KEY=client_input
      --add-opens=java.base/jdk.internal.loader=ALL-UNNAMED
      --add-opens=jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED
      --add-opens=java.base/java.net=ALL-UNNAMED
  • Final Configuration and Startup

    • Ensure oasis.properties is properly updated.

    • Start tomcatui and tomcatjob services from Services panel.

    • Set Startup type to Automatic (Delayed Start) for both.

    • Update Log On settings with proper credentials and restart services.


Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.

Last updated

Was this helpful?