Tomcat via Containers

Last modified: July 9, 2024

Overview

This document explains how to set up Apache Tomcat® in an EasyApache 4 container. This document only applies to the EasyApache 4-provided Tomcat package. You can only install container-based packages on systems that use EasyApache 4’s containers and run AlmaLinux OS, Rocky Linux™, or Ubuntu®.

We provide Tomcat versions 10.0 and 10.1 for use with containers. Tomcat 10.0 is currently end-of-life (EOL) but will continue to function.

Note:

In this documentation, container-name represents the name of your Tomcat container. You can find the names of your containers with either the registered or running options of the /usr/local/cpanel/scripts/ea-podman script.

Important:

You must log in with SSH as the user. You cannot use the su - or sudo -E commands to run this script.

Install Tomcat via containers

To install Tomcat in a container on a system that runs EasyApache 4, you must first set up EasyApache 4 containers on your system.

After you set up containers on your system, your system administrator must install the ea-tomcat101 package to add Tomcat to your system.

On the command line

Use one of the following commands to install the Tomcat package on your server.

To install Tomcat on AlmaLinux or Rocky Linux, run the following command:

dnf install -y ea-tomcat101

To install Tomcat on Ubuntu, run the following commands:

1
2


apt install -y ea-tomcat101
apt update

Set up Tomcat inside containers

To set up Tomcat to run inside a container, perform the following steps:

Log in to the cPanel user account via SSH. You can do this by either logging in to the account via SSH from the command line, or using SSH in either WHM’s Terminal interface (WHM » Home » Server Configuration » Terminal) or cPanel’s Terminal interface (cPanel » Home » Advanced » Terminal).

Run the following command:

/usr/local/cpanel/scripts/ea-podman install ea-tomcat101

Run the following command to retrieve the container’s name. You will need this name to perform any further actions.
```
/usr/local/cpanel/scripts/ea-podman containers
```

For more information, read our /usr/local/cpanel/scripts/ea-podman script documentation.

Configure Tomcat in a container

Note:

cPanel users must have shell access to configure Tomcat in a container.

When you install Tomcat in a container, it creates a directory in the ~/ea-podman.d/container-name directory in the user’s home directory. The system creates several directories when you set up Tomcat in containers.

Default configuration

EasyApache 4 makes the following configuration changes from the default Tomcat 10.1 behavior to the ~/ea-podman.d/container-name/conf/server.xml file:

Disables the shutdown port by default.
Sets the xpoweredBy attribute of all connectors to a false value.
Removes the redirectPort attribute.
Adds the ErrorReportValue class to all hosts with the showServerInfo value set to a false value.
Sets the following host attributes to a false value:
- autoDeploy
- deployOnStartup
- deployXML
- unpackWARs

Interact with your Tomcat container

When you install Tomcat into a container, it creates a directory in the ~/ea-podman.d/container-name directory in the user’s home directory. The system creates several directories when you set up Tomcat in containers.

You can use this directory to manage the information, files, and other data for the container.

Deploy applications in a Tomcat container

The default configuration of Tomcat containers allows you to choose the best method to deploy your applications.

To determine which deployment method is the best for you, read Apache’s Tomcat Security Considerations documentation. For more information about how to use that deployment method, read Apache’s Tomcat Web Application Deployment documentation.