Self Service Password Reset is a web application. When you install Self Service Password Reset, you are deploying a WAR (Web application ARchive) file as Java servlet application running on the Apache Tomcat web server. The WAR file contains an Apache Tomcat implementation of the Self Service Password Reset application. The following procedures work for the supported distributions of Linux.
You must have Java and Apache Tomcat installed and running on Linux before you deploy the WAR file. If you already have Java and Tomcat installed, proceed to Section 5.2.2, Setting operating system environment variables. Follow these steps to install and validate the installation of Java and Tomcat.
To install Java and tomcat:
Install Java 11. For more information, see the JDK installation guide.
Verify JAVA_HOME (or JRE_HOME) path is set appropriately by entering:
echo $JAVA_HOME
or
echo $JRE_HOME
Install Tomcat 9. For more information, see the Apache Tomcat documentation.
Start Tomcat by executing the catalina.sh script in the Tomcat_Home/bin directory.
./catalina.sh start
Validate you can access http://localhost:port. The default port is 8080.
Check the Tomcat_Home/logs/catalina.out file for any errors if you are unable to access the default Tomcat page.
Self Service Password Reset, as a Java servlet application running on Apache Tomcat, requires several operating system environmental variables to be set. There are various methods for setting environmental variables depending on the operating system. The recommended place to specify these variables is a setenv script.
The following are the Self Service Password Reset specific environment variables:
SSPR_APPLICATIONPATH (Required): Specifies where Self Service Password Reset stores its configuration data file (SSPRConfiguration.xml). This file contains all of the Self Service Password Reset configuration data. The specified path must exist prior to starting Self Service Password Reset.
For example: export SSPR_APPLICATIONPATH="/etc/opt/microfocus/sspr"
CATALINA_OPTS: Allows specification of additional options for the Java command that starts Apache Tomcat. The recommended Java options for the Self Service Password Reset Java servlet application running on Apache Tomcat include:
-Xms
Specifies the initial heap memory allocation pool.
-Xmx
Specifies the maximum heap memory allocation pool for a Java Virtual Machine (JVM).
Setting the initial and maximum heap memory size to the same size is a best practice because the JVM does not increase heap memory size at runtime. The recommended SSPR heap memory size is 1 GB (1024 MB). For more information about how to set Java heap size, see the Apache Tomcat Documentation.
For example: export CATALINA_OPTS="-Xms1024M -Xmx1024M"
The following is an example of a setenv script located here Tomcat_Home/bin/setenv.sh:
export SSPR_APPLICATIONPATH="/etc/opt/microfocus/sspr" export CATALINA_OPTS="-Xms1024M -Xmx1024M"
After you have installed Java and Apache Tomcat and they are running with the appropriate OS environmental variables set, you must deploy the Self Service Password Reset WAR file. Ensure that you have downloaded and extracted the file. For more information, see Obtaining Self Service Password Reset.
To deploy the WAR file on Linux:
Copy the sspr.war file to the Tomcat_Home/webapps/ directory.
When Apache Tomcat discovers the sspr.war file in the Tomcat_Home/webapps/ directory, Apache Tomcat auto-deploys Self Service Password Reset in an automatically created directory; Tomcat_Home/webapps/sspr/.
Stop Apache Tomcat by running the catalina.sh script in the Tomcat_Home/bin directory.
./catalina.sh stop
Start Apache Tomcat by running the catalina.sh script in the Tomcat_Home/bin directory.
./catalina.sh start
After deploying the WAR file, you must configure your environment to work with Self Service Password Reset. For more information, see Configuring your environment for Self Service Password Reset.