If you did not install the product on the server
where you are deploying the help, you can deploy the help on Apache
Tomcat application server.
Before you begin
- The server that you configure the help content on
must be available to your users behind the firewall.
- A help.war file is on your
server.
- If the product that you are configuring the help for is installed
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 the product is not installed on the server or the 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 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; for example:
- 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; for example:
- Windows: C:\Program
Files\Java70
- Linux: /usr/local/java70/
- Download the Apache Tomcat server application.
- Extract the compressed Apache Tomcat archive.
- Move the extracted folder to a permanent location. This location
is referred to as CATALINA_HOME;
for example: C:\apache-tomcat-version
- Create a CATALINA_HOME environment variable and
set the value to the CATALINA_HOME directory; for
example: C:\apache-tomcat-version
- Add a server administrator user to the CATALINA_HOME/conf/tomcat-users.xml file
and save the changes; for example:
<role rolename="manager-gui"/>
<user username="admin" password="admin" roles="manager-gui"/>
- Open the CATALINA_HOME/bin directory
start the Apache Tomcat server by running the startup file. The name
of the file differs depending on your operating system.
- Windows: startup.bat
- Linux: startup.sh
Apache Tomcat is running when the information message in a
command-line utility is Server Startup in number ms.
Procedure
To deploy the help.war file:
- 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 included 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. For
example: http://localhost:8080/help/index.jsp.
Note: - The help system might not contain help
content yet. Next, install the documentation into the help system.
- 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 help content on the server by completing
one of the following tasks:
- Provide the information center URL to the users in
your organization to enter in their preferences. Ensure that the server
you provide is not localhost.
Example: http://server.ibm.com:8080/help/index.jsp