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
- 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.
- Extract the contents of the compressed file on your server. If you receive an error that indicates that the path is too long when you extract the compressed file, move the file to a directory with a shorter path. Use a directory such as C:\kcci and extract the file there.
- Read the following files in the extracted KnowledgeCenter directory:
- termsofuse.html (Terms of Use statement)
- NOTICES.txt file
- Download the compressed file that contains the product help:
- In a browser, go to the help download site.
- 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. - Extract the contents of the usr directory from the compressed help file into the usr directory in the local KnowledgeCenter directory. Accept any prompts to overwrite or merge the contents of that directory.
- 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.
- 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 Application Developer version 9.1.1, this might be:
http://<my_server>:9090/kc/SSRTLW_9.1.1/. 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. 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: Ensure that the IBM Knowledge Center is always running on the server, so that it is available to team members. Configure the startup script to run when the server is rebooted or create a shortcut to this script on your desktop and run it after you reboot the server. - For more information on starting, stopping, and configuring the IBM Knowledge Center, see the instructions in this file: KnowledgeCenter/knowledgecenter_instructions.html.
Feedback