Reviewing the setup requirements for each configuration

As you are selecting which configuration best suits your environment, consider the setup requirements for each of the configurations.

Before you begin

Table 1. Help content configurations
Setup type	Description
1. Remote help	You access content directly from the public IBM Knowledge Center. Content is always the latest version. Requires the smallest amount of space because only the infrastructure is installed. An internet connection is required. No additional setup is required. This configuration is the default selection.
2. Local help	Content is installed on your computer. An Internet connection is not required to view the content. When changes are available from a remote update site, you can install them.
3. Intranet help	An administrator in your organization downloads and installs the help content on a server in your intranet network. Team members redirect their help clients to access the help on the server without an Internet connection. Used primarily in enterprise environments that have limited Internet access.

No configuration is required by the administrator or the user. The remote IBM Knowledge Center is already added as the product help preference.

Both administrators and users must complete their required steps.

Administrator: Set up the help system on a server by following the instructions that are appropriate for the application server that is installed on your server:
- Deploying the help system on Apache Tomcat
  Note: If you did not install an application server on your help server yet, use Apache Tomcat.
- Deploying the help system on IBM WebSphere Application Server
Administrator: Download and install the help content by following the instructions in one of the following topics:
- Installing help content locally from the help archive site
- Installing help content locally from a downloaded archive file
Administrator: Provide the server, port, and path to the users in your organization for them to enter in the Installation Manager Help System page.
- Server: The name of the server
- Port: The port number
- Path: A slash and the help context
User: Install the product. In the Installation Manager Help System Configuration page, select Access help from a server on your intranet and enter the server, port, and path to the help system.
Example: http://server.ibm.com:8080/help-name/index.jsp
- Server: server.ibm.com
- Port: 8080
- Path: /help-name
User: Open the product and click Help > Help contents to verify that the help content displays correctly and is accessed from the server.

When local help is selected, use these tasks to install the content.

Install and open the product.
Administrator: Download and install the help content by following the instructions in one of the following topics:
- Installing help content locally from the help archive site
- Installing help content locally from a downloaded archive file
To verify the installation, click Help > Help contents.

Feedback