> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release7.2/deployment-and-maintenance/installation/tomcat-10.1.x-on-ubuntu-22.04.md). # Tomcat 10.1.x on Ubuntu 22.04 This article 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**](/release7.2/deployment-and-maintenance/installation/java-17.x-on-ubuntu-22.04+.md)) * MySQL (local VM [**Installation of MySQL on Ubuntu 22.04**](/release7.2/deployment-and-maintenance/installation/mysql-8.4.x-on-ubuntu-22.04+.md) 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 ```
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/`\
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.
* 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 ```
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.
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.
6. **Update Configuration Files** * Edit `oasis.properties` in `extprop` folder
* **Database Section:** Replace localhost, username, and password with your MySQL connection details. * **Elasticsearch Section:** * 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`\ \ \ \
* 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
* 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 ```
* 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 ```
10. **Access the Application** * After a few minutes, open a browser and go to: ``` http://:8080/ovaledge ```
### Multi Tomcat Installation 1. **Log in to Application VM** ```bash ssh @ ```
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.
3. **Download Required Files** * Download the `oasis.properties` and `log4j.properties` files into the folder. These files will be shared by the OvalEdge team.
* Download the JAR files provided by the OvalEdge team and place them in the third\_party\_jars folder.
* 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 ```
Extract the Apache Tomcat archive with the following command: ```bash tar -xvf apache-tomcat-10.1.40.tar.gz ```
### 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 ```
#### 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/ ```
*

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" ```
* Save and exit. ### Tomcat Job Instance Setup * Duplicate the UI Tomcat Instance. ```bash cp -R ~/tomcatui ~/tomcatjob ```
* 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" ```
* 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`
* 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 ```
* 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 ```
* 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, configure the application properties to reflect your environment. **Edit `oasis.properties` File** * Navigate to the `extprop` folder and open the file: ```bash cd /home/ovaledge/extprop vi oasis.properties ``` * **Database Configuration** * Replace `localhost` with your MySQL endpoint. * Replace `username` and `password` with your actual MySQL credentials.
* **Elasticsearch Configuration** * 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 external JAR files.
* Example: ```properties external.jars.path=/home/ovaledge/third_party_jars ``` * *(Insert sample reference screenshot here)* * Save and close the file. **Edit `log4j.properties` File** * Navigate to the `extprop` folder and open the file: ```bash vi log4j.properties ``` * At the top of the file, locate two lines — one commented out, the other active. * Update as follows: * Uncomment the first line. * Comment out the second line.
* Save and close the file. **Start Tomcat Services** * Reload `systemd` and enable Tomcat services to start on boot: ```bash sudo systemctl daemon-reload sudo systemctl enable tomcatui sudo systemctl enable tomcatjob ``` * Start services:
```bash sudo systemctl start tomcatui sudo systemctl start tomcatjob ```
**Access the Application** * Wait approximately 2 minutes after starting the services. * Open a web browser and access:
``` http://:8080/ovaledge ```
* Replace `` with the actual VM IP address. *** Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ovaledge.com/release7.2/deployment-and-maintenance/installation/tomcat-10.1.x-on-ubuntu-22.04.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.