If you did not install the product on the server
you are deploying the help, you can use Apache Tomcat as a simple
application server solution on which to deploy your help system.
Before you begin
- The server on which you are configuring help content
must be available to your users behind the firewall.
- Verify that you have a help.war file
available on your server.
- If you installed the product you are configuring the help for
on the server, a help.war file might be installed
already.
- Look in the installation_directory/help directory
for the help.war file.
- Look for a version of the file that includes the product abbreviation,
such as clmhelp.war or ramhelp.war
- Search your installation directory for *help.war.
- If you did not install the product on the server or your product
did not include a help.war file, download a version
of the help.war file.
- Install and configure Apache Tomcat.
- Install a Java™ Runtime
Environment (JRE) or Java Development
Kit (JDK). You can choose to install one of the IBM® developer kits.
- Set an environment variable with the path to the JRE or JDK:
- If you installed a JRE, create a JRE_HOME environment
variable and set the value to the path of the directory where you
installed the JRE. Examples:
- Windows: C:\Program
Files\Java70\jre
- Linux: /usr/local/java70/jre
- If you installed a JDK, create a JAVA_HOME environment
variable and set the value to the path of the directory where you
installed the JDK. Examples:
- Windows: C:\Program
Files\Java70
- Linux: /usr/local/java70/
- Download the Apache Tomcat server application.
- Extract the Apache Tomcat archive.
- Move the extracted folder to a permanent location. This location
is referred to as CATALINA_HOME.
Example: C:\apache-tomcat-version
- Create a CATALINA_HOME environment variable and
set the value to the CATALINA_HOME directory. Example: C:\apache-tomcat-version
- Add a server administrator user to the CATALINA_HOME/conf/tomcat-users.xml file
and save the changes. Example:
<role rolename="manager-gui"/>
<user username="admin" password="admin" roles="manager-gui"/>
- Open the CATALINA_HOME/bin directory
and run the startup file to start the Apache Tomcat server.
- Windows: startup.bat
- Linux: startup.sh
Apache Tomcat is running when the information message shows Server
Startup in number ms in a command-line
utility.
Procedure
To deploy the help.war:
- In a browser, enter the following URL to open the Tomcat
Manager Application: http://localhost:8080/manager/html
- Enter the user name and password.
- In the section, click Choose
file.
- Select the help.war file.
- Click Deploy. The help.war file
is deployed, started, and displayed in the Applications section.
The help.war file is also copied to the CATALINA_HOME/webapps directory.
- Verify that you can access the help system by adding help/index.jsp to
the end of your server application URL where help is
the name of your .war file. Example: http://localhost:8080/help/index.jsp.
Note: - The help system might not contain help
content yet. You might be required to install the documentation into
the help system next.
- If your help system is deployed on the same Apache Tomcat server
as the product, the help system starts and stops when the product
application is started and stopped.
What to do next
- Install the documentation on the server:
- Provide users with the server, the port, and the path
to the help system to enter in the Help System Configuration page
in IBM Installation Manager.
Ensure that the server you provide is not localhost.
Example:
http://server.ibm.com:8080/help/index.jsp- Server: server.ibm.com
- Port: 8080
- Path: /help