Configure environment variables for Apache Tomcat

1min
You must correctly configure the JAVA_HOME environment variable to enable Java applications and tools to locate the installed JDK (Java Development Kit) on your system. Apache Tomcat also requires the CATALINA_HOME environment variable to point to the directory where Tomcat is installed. This section shows how to set the JAVA_HOME and CATALINA_HOME environment variables and update the system PATH variable on Linux and Windows operating systems.
To ensure proper compatibility between Java SunPKCS11 and the Futurex PKCS11 module, you must use Oracle Java and not OpenJDK. Oracle Java 11, 17, and 21 are currently supported.
Select your operating system and perform the instructions:
Linux
Windows
1
Determine the installation path of Oracle Java:
Find the path where Oracle Java is installed, such as /usr/lib/jvm/. Use the following command to list the installed JDKs:
Shell
ls /usr/lib/jvm/
ls /usr/lib/jvm/
﻿
For example, if you installed Oracle Java 11, the path is likely /usr/lib/jvm/java-11-openjdk-amd64.
2
Determine the installation path of Tomcat:
You can use the find command to locate the Tomcat installation directory:
Shell
sudo find / -name "catalina.sh"
sudo find / -name "catalina.sh"
﻿
The catalina.sh script is located in the bin directory of the Tomcat installation. The directory containing catalina.sh is the CATALINA_HOME.
3
Edit the profile file:
Open a terminal and use a text editor to edit the /etc/profile file, which the system uses when users log in. You might need superuser privileges to edit this file.
Shell
sudo nano /etc/profile
sudo nano /etc/profile
﻿
4
Add the Environment Variables and Update PATH:
Add the following lines to the end of the /etc/profile file, replacing the paths with your actual installation paths:
Shell
export JAVA_HOME=/path/to/jdk
export CATALINA_HOME=/path/to/tomcat
export PATH=$PATH:$JAVA_HOME/bin:$CATALINA_HOME/bin
export JAVA_HOME=/path/to/jdk
export CATALINA_HOME=/path/to/tomcat
export PATH=$PATH:$JAVA_HOME/bin:$CATALINA_HOME/bin
﻿
5
Apply the changes:
After saving the file, apply the changes by sourcing the profile file:
Shell
source /etc/profile
source /etc/profile
﻿
6
Verify the configuration:
To ensure that the JAVA_HOME variable is set correctly and the PATH is updated, you can check their values with the following commands:
Shell
echo $JAVA_HOME
echo $CATALINA_HOME
echo $PATH
echo $JAVA_HOME
echo $CATALINA_HOME
echo $PATH
﻿
You should see the individual paths set for JAVA_HOME and CATALINA_HOME, as well as their inclusion in the PATH.
Windows Instructions
1
Determine the installation path of Oracle Java:
Ensure Oracle Java is installed on your system. Note the installation path, typically something like C:\Program Files\Java\jdk-11.
2
Determine the installation path of Tomcat:
Ensure Apache Tomcat is installed on your system. Note the installation path. Common default installation paths include C:\Program Files\Apache Software Foundation\Tomcat or C:\Tomcat.
3
Open System Properties:
Select the Win + Pause/Break keys to open the System Properties window, or right-click This PC (or My Computer) and select Properties.
Select Advanced system settings on the left sidebar.
4
Open Environment Variables:
In the System Properties window, select [ Environment Variables ] near the bottom of the window.
5
Create New System Variables:
In the Environment Variables window, in the System variables section, select [ New ]. This opens the New System Variable dialog.
Enter the following for JAVA_HOME:
Variable name: JAVA_HOME
Variable value: The path to your JDK installation (such as C:\Program Files\Java\jdk-11)
For CATALINA_HOME:
Variable name: CATALINA_HOME
Variable value: The path to your Tomcat installation (such as C:\Program Files\Apache Software Foundation\Tomcat or C:\Tomcat)
6
Update the PATH Variable:
In the System variables section, find and select the Path variable, then select [ Edit ]. This opens the Edit Environment Variable dialog.
Add new entries:
Select [ New ] and add %JAVA_HOME%\bin
Select [ New ] and add %CATALINA_HOME%\bin
7
Apply Changes:
Select [ OK ] on each dialog box to apply the changes and exit the dialog boxes.
8
Verify the Configuration:
Open a new Command Prompt window (select the Win + R keys, type cmd, and press Enter).
Type echo %JAVA_HOME% and select the Enter key. You should see the path to your JDK installation.
Type echo %CATALINA_HOME% and select the Enter key. You should see the path to your Tomcat installation.
Type echo %PATH% and select the Enter key. You should see the JAVA_HOME and CATALINA_HOME environment variables included in the PATH.
Type java -version to confirm that the system recognizes the Java installation.
﻿
Updated 03 Dec 2024
Did this page help you?
Install and configure Futurex PKCS11
Configure SunPKCS11 to use the Futurex PKCS11 module