# Tomcat on Ubuntu 22.04 ## Introduction This document provides detailed steps to install and configure the OvalEdge Application on an Ubuntu 22.04 machine. It includes both single-instance and multi-instance (UI and Job) deployment options using Apache Tomcat. ### Prerequisites * Ubuntu 22.04 system with internet access * A user with sudo privileges * Java 17 installed ([**Installation of JAVA on Ubuntu 22.04**](https://docs.ovaledge.com/~/changes/967/deployment-and-maintenance/installation/java-17.x-on-ubuntu-22.04+)) * MySQL (local VM [**Installation of MySQL on Ubuntu 22.04**](https://docs.ovaledge.com/~/changes/967/deployment-and-maintenance/installation/mysql-8.4.x-on-ubuntu-22.04+) or AWS RDS) installed and accessible * Required configuration files and `.jar` packages provided by OvalEdge Support ### Single-Instance Deployment (Single Tomcat) 1. #### Create Required Directories * Log in to the application VM and create the following directories to store application configuration files and dependencies: ```bash mkdir ~/extprop ~/temp ~/third_party_jars ``` \ Sample Reference Screenshot:

The oasis.properties and log4j.properties files will be provided by the OvalEdge Team. Place them in the extprop folder.
JAR files required for the application will also be provided. Place them in the third_party_jars folder.

2. Place Configuration Files * Download and place the following files into the respective folders (provided by OvalEdge Support): * `oasis.properties` → `~/extprop/` * `log4j.properties` → `~/extprop/` * Third-party JARs → `~/third_party_jars/`\
\ Sample Reference Screenshot:

3. Download and Extract Tomcat * Download the required JAR file into the `third_party_jars` folder as shown below. The JAR files will be provided by the OvalEdge team.\ \ Sample Reference Screenshot:

* Now download the Tomcat using the URL below as shown. **Link:** [Tomcat Link](https://ovaledge.s3.us-west-1.amazonaws.com/scripts/hardened_tomcat/apache-tomcat-10.1.40.tar.gz) ```bash wget https://ovaledge.s3.us-west-1.amazonaws.com/scripts/hardened_tomcat/apache-tomcat-10.1.40.tar.gz tar -xvf apache-tomcat-10.1.40.tar.gz ``` \ Sample Reference Screenshot 01:

\ Sample Reference Screenshot 02:

4. Configure Environment Variables * Navigate to the Tomcat bin directory and create the `setenv.sh` file: ```bash vi apache-tomcat-10.1.40/bin/setenv.sh ``` Add the following (replace `` with the actual key): ```bash export CATALINA_OPTS="-Duse.http=true -DOVALEDGE_SECURITY_TYPE=db \ -Dlog4j.configuration=file:/home/ovaledge/extprop/log4j.properties \ -Dext.properties.dir=file:/home/ovaledge/extprop/ -Xms4g -Xmx7g \ -DOVALEDGE_ENCRYPT_DECRYPT_KEY= \ --add-opens=jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED \ --add-opens=java.base/jdk.internal.loader=ALL-UNNAMED \ --add-opens=java.base/java.net=ALL-UNNAMED" ``` ✅ Ensure the path to `oasis.properties` and `log4j.properties` is correct.\ \ Sample Reference Screenshot:

5. Deploy OvalEdge Application * Navigate to the webapps directory and copy or download the `ovaledge.war` file (provided by the OvalEdge Team): * Place the `ovaledge.war` file into the `webapps` directory.\ \ Sample Reference Screenshot:

6. Update Configuration Files * Edit `oasis.properties` in `extprop` folder\ \ Sample Reference Screenshot:

* **Database Section:** Replace localhost, username, and password with your MySQL connection details. * **Elasticsearch Section:**\ Sample Reference Screenshot:

* Set `elasticsearch.enabled=true` * Set `es.host` and `es.password` with actual values * Update the JARs path to point to the `third_party_jars` folder: * `/home/ovaledge/third_party_jars`\ \ \ \ \ \ Sample Reference Screenshot:

* Save the file after making changes. 7. Update `log4j.properties` Configuration * Edit the `log4j.properties` file in the `extprop` directory: * Uncomment the 1st line * Comment the 2nd line\ \ Sample Reference Screenshot:

* Save the file after editing. 8. Create Tomcat Service * Create a systemd service file to manage Tomcat as a Linux service: ```bash sudo vi /etc/systemd/system/tomcat.service ``` * Paste the following content: ```ini [Unit] Description=Apache Tomcat for OvalEdge After=network.target [Service] Type=forking WorkingDirectory=/home/ovaledge/apache-tomcat-10.1.40/bin ExecStart=/bin/bash /home/ovaledge/apache-tomcat-10.1.40/bin/startup.sh ExecStop=/bin/bash/home/ovaledge/apache-tomcat-10.1.40/bin/shutdown.sh User=ovaledge Group=ovaledge [Install] WantedBy=multi-user.target ``` \ Sample Reference Screenshot:

* Save and close the file. 9. Start and Enable Tomcat * Run the following commands to register and start the Tomcat service: ```bash sudo systemctl daemon-reload sudo systemctl enable tomcat sudo systemctl start tomcat ``` Sample Reference Screenshot:

10. Access the Application * After a few minutes, open a browser and go to: ``` http://:8080/ovaledge ``` \ Sample Reference Screenshot:

### Multi Tomcat Installation 1. Log in to Application VM ```bash ssh @ ``` \ Sample Reference Screenshot:

2. Create Required Directories * Create the following directories to store configuration files and external libraries: ```bash mkdir ~/extprop ~/temp ~/third_party_jars ```

oasis.properties and log4j.properties will be provided by the OvalEdge team. Place them in the extprop folder.
JAR files required for the application should be placed in the third_party_jars folder.

\ Sample Reference Screenshot:

3. Download Required Files * Download the `oasis.properties` and `log4j.properties` files into the `extprop` folder. These files will be shared by the OvalEdge team. \ Sample Reference Screenshot:

* Download Tomcat: [Tomcat Link](https://ovaledge.s3.us-west-1.amazonaws.com/scripts/hardened_tomcat/apache-tomcat-10.1.40.tar.gz) ```bash wget https://ovaledge.s3.us-west-1.amazonaws.com/scripts/hardened_tomcat/apache-tomcat-10.1.40.tar.gz tar -xvf apache-tomcat-10.1.40.tar.gz ``` \ Sample Reference Screenshots:

4. Download WAR and Config Files * Place the following files (provided by OvalEdge): * `ovaledge.war` → to be placed in `webapps` of each Tomcat instance * `oasis.properties`, `log4j.properties` → `~/extprop` * Additional JARs → `~/third_party_jars` ### Tomcat UI Instance Setup * Once the above steps are completed, rename the apache-tomcat-10.1.40 directory to tomcatui as shown below. ```bash mv apache-tomcat-10.1.40 tomcatui ``` \ Sample Reference Screenshot:

#### Deploy WAR File * Navigate to the tomcatui/webapps folder and download the ovaledge.war file as shown below. ```bash cp ~/Downloads/ovaledge.war ~/tomcatui/webapps/ ``` \ Sample Reference Screenshot:

The ovaledge.war file will be provided by the OvalEdge team.

#### Configure Environment Variables * Create and edit the setenv.sh file inside tomcatui/bin: ```bash vi ~/tomcatui/bin/setenv.sh ``` * Paste the following content (replace with the actual value shared by OvalEdge): ```bash export CATALINA_OPTS="-Duse.http=true \ --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 \ -DOVALEDGE_SECURITY_TYPE=db \ -Dext.properties.dir=file:/home/ovaledge/extprop/ \ -DOVALEDGE_ENCRYPT_DECRYPT_KEY= \ -Dpod.type=ovaledge-ui-deployment \ -Xms4g -Xmx8g" ``` \ Sample Reference Screenshot:

* Save and exit. #### Tomcat Job Instance Setup * Duplicate the UI Tomcat Instance. ```bash cp -R ~/tomcatui ~/tomcatjob ``` \ Sample Reference Screenshot:

* Update Job `setenv.sh`: ```bash vi ~/tomcatjob/bin/setenv.sh ``` * Replace the content with: ```bash export CATALINA_OPTS="-Duse.http=true \ --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 \ -DOVALEDGE_SECURITY_TYPE=db \ -Dext.properties.dir=file:/home/ovaledge/extprop/ \ -DOVALEDGE_ENCRYPT_DECRYPT_KEY= \ -Dpod.type=ovaledge-job-deployment \ -Xms4g -Xmx8g" ``` \ Sample Reference Screenshot:

* Ensure that the -Dpod.type is set to ovaledge-job-deployment. * Save and exit the file. #### Update Ports in Job Instance * Edit `server.xml`: ```bash vi ~/tomcatjob/conf/server.xml ``` * Change the following ports to avoid conflicts with the UI instance: * Default Port New Port for Job * Shutdown port: `8005 → 8006` * HTTP connector port: `8080 → 8081` Sample Reference Screenshot 01

\ Sample Reference Screenshot 02

* Make sure all port references are updated correctly. Save and exit. #### Expose Tomcat Instances as Systemd Services To enable Tomcat UI and Job instances to start, stop, and restart as managed services on Linux, follow the steps below: * Navigate to the Systemd Directory. ```bash cd /etc/systemd/system ``` * Create the tomcatui Service File. * Create a systemd service unit for the UI instance: ```bash sudo vim tomcatui.service ``` * Paste the following configuration: ```ini [Unit] Description=Apache Tomcat Web Application Container for OvalEdge UI After=syslog.target network.target [Service] Type=forking WorkingDirectory=/home/ovaledge/tomcatui/bin ExecStart=/bin/bash /home/ovaledge/tomcatui/bin/startup.sh ExecStop=/bin/bash /home/ovaledge/tomcatui/bin/shutdown.sh User=ovaledge Group=ovaledge [Install] WantedBy=multi-user.target ``` \ Sample Reference Screenshot:

* Save and exit the file. * Create the Tomcat Job Service File. * Create the service file for the Job instance: ```bash sudo vim tomcatjob.service ``` * Insert the following content: ```ini [Unit] Description=Apache Tomcat Web Application Container for OvalEdge Job After=syslog.target network.target [Service] Type=forking WorkingDirectory=/home/ovaledge/tomcatjob/bin ExecStart=/bin/bash /home/ovaledge/tomcatjob/bin/startup.sh ExecStop=/bin/bash /home/ovaledge/tomcatjob/bin/shutdown.sh User=ovaledge Group=ovaledge [Install] WantedBy=multi-user.target ``` \ Sample Reference Screenshot:

* Save and exit the file. * Reload Systemd Services * Reload the systemd daemon to apply the newly created service units: ```bash sudo systemctl daemon-reload ``` #### Configure oasis.properties and log4j.properties Files After completing the deployment steps, you must configure the application properties to reflect your environment. Follow the steps below: * Edit oasis.properties File * Navigate to the extprop folder and open the oasis.properties file in a text editor: ```bash cd /home/ovaledge/extprop vi oasis.properties ``` #### Database Configuration * Update the database-related properties: * Replace localhost with your MySQL endpoint.

* Replace username and password with your actual MySQL credentials. Example: ```properties db.url=jdbc:mysql://:3306/ovaledge db.username= db.password= ``` \ Sample Reference Screenshot:

* Set `elasticsearch.enabled=true` if Elasticsearch is available. * Provide your Elasticsearch host details.\ Example: ```properties elasticsearch.enabled=true es.host= es.password= ``` * **JARs Path Configuration** * Specify the correct path for the external JAR files. If you downloaded the JARs to the third\_party\_jars folder, update the path accordingly:\ \ Sample Reference Screenshot:

\ Example: ```properties external.jars.path=/home/ovaledge/third_party_jars ``` * Save and close the file. * Edit log4j.properties File * Navigate to the extprop folder and open log4j.properties: ```bash vi log4j.properties ``` \ At the top of the file, you'll find two lines — the first is commented out and the second is active. Update them as follows: * Uncomment the first line. * Comment out the second line.\ \ **Sample Reference Screenshot:**

\ **Before:** ```properties #log4j.rootLogger=DEBUG, console, file log4j.rootLogger=INFO, console, file ``` \ **After:** ```properties log4j.rootLogger=DEBUG, console, file #log4j.rootLogger=INFO, console, file ``` * Save and close the file. * Start Tomcat Services * Reload systemd and enable both Tomcat services to start on boot, then start them: ```bash sudo systemctl daemon-reload sudo systemctl enable tomcatui sudo systemctl enable tomcatjob sudo systemctl start tomcatui sudo systemctl start tomcatjob ``` \ Sample Reference Screenshot:

* Access the Application * Wait for approximately 2 minutes after starting the services, then access the application in a web browser: `http://:8080/ovaledge`