Installing help on an intranet server

An administrator can install and deploy the help content on an intranet server behind a firewall. Then, team members can access help on their network without using the Internet or downloading content to their computers.

Procedure

  1. Locate the IBM® Knowledge Center that is installed with your product. Typically, it is a compressed file that is located in a kcci_install directory. The file includes KC_CI in the file name and a .zip extension.
    Note: For products that include a server component, the compressed file for the IBM Knowledge Center is typically installed with the server. You can extract the compressed file on that server, or copy it to another server. For products that have a client only, the file is included in that installation. You can copy that file to a server on your intranet. To verify the location of the compressed file, see the installation instructions in your product release notes or downloadable files document from IBM Support.
  2. Extract the contents of the compressed file on your server. If you receive an error that indicates that the path is too long, move the file to a directory with a shorter path. Use a directory such as C:\kcci and extract the file there.
  3. Read the following files in the extracted KnowledgeCenter directory:
    • termsofuse.html (Terms of Use statement)
    • NOTICES.txt file
  4. Download the compressed file that contains the product help:
    1. In a browser, go to the help download site.
    2. In the kcci_content directory, download the compressed file that corresponds to your installed product and its version.
    Note: An administrator can download the compressed file and place it on a server on your network. In this case, copy the compressed file from that server to your computer.
  5. Extract the contents of the compressed help file into the KnowledgeCenter directory, which is under the directory you used in step 2. The compressed help file contains a usr directory that must be merged with the usr directory in the Knowledge Center. Accept any prompts to overwrite or merge the contents of that directory.
  6. Start the IBM Knowledge Center by running one of these scripts from the KnowledgeCenter/bin directory:
    • Windows systems: startKC.bat
    • UNIX systems: ./bin/startKC.sh
    • OS X systems: sh startKC.sh

    If a Java™ error occurs when you start the IBM Knowledge Center, see No JAVA_HOME defined error.

  7. After the server is started, the IBM Knowledge Center is available in a browser at this default URL: http://<server_name>:9090/kc/<product_code_and_version>/. For example, for IBM Rational Collaborative Lifecycle Management version 6.0.4, this might be: http://<my_server>:9090/kc/SSYMRC_6.0.4/. To access this help from a product client, team members must add this URL as a new help content connection in their client Help Preferences. See Changing help content connections.

    If port 9090 is in use, the help uses another port when it is started. This port value is briefly displayed in the IBM Knowledge Center startup window. After the window closes, the port number is recorded in this file: KnowledgeCenter/logs/port.properties.

    Note: To ensure that the local IBM Knowledge Center is available each time you use the product, you can create a shortcut to the startup script on your desktop and run it before you open the product client.
  8. For more information on starting, stopping, and configuring the IBM Knowledge Center, see the instructions in this file: KnowledgeCenter/knowledgecenter_instructions.html.

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