Help content configurations

You can configure the product help content in one of three ways. You can use the default connection to the remote IBM® Knowledge Center that is on the Internet. Team members can download product help and deploy the IBM Knowledge Center locally on their computers. Or, an administrator can download product help and deploy the IBM Knowledge Center on a server on the network.

Descriptions of the help configurations

Consider the configuration options and select one that meets the needs of your organization.
Table 1. Help content configurations
Setup type Description
Remote help
  • This configuration is the default selection. No additional setup is required.
  • An Internet connection is required.
  • You access content directly from the public IBM Knowledge Center.
  • Content is always the current version.
  • Requires the smallest amount of space because only the infrastructure is installed.
Local help
  • Extract the IBM Knowledge Center that is installed with your product and deploy it on your local computer. Download the product help from the help download site and extract the contents into the local IBM Knowledge Center.
  • Access the help by pointing to a local URL in your browser. An Internet connection is not required to view the content.
  • See Installing local help on your computer.
Intranet help
  • An administrator extracts the IBM Knowledge Center that is installed with the product and deploys it on a local server. The administrator downloads the product help from the help download site and extracts the contents into the IBM Knowledge Center on the local server. See Installing help on an intranet server.
  • Team members redirect their help clients to access the help on the server. See Changing help content connections.
  • This help deployment is used primarily in enterprise environments that have limited Internet access.

Considerations for selecting a configuration

Review the list of considerations to make when you are selecting a help configuration for yourself or your organization.

Table 2. Considerations for selecting a configuration
Consideration Remote help Local Help Intranet help
To configure the help, an Internet connection is required. Yes Yes* Yes*
To view the help, an Internet connection is required. Yes No No
The configuration is appropriate for an environment with limited Internet access. No Yes Yes
An administrator must install the help and configure the web application to access the help. No No Yes
Users must install the help and set a new help connection. No Yes No
Note: *An Internet connection is not required if your product is installed with the full set of documentation.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki