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
- To download a compressed file that contains the customer installable IBM® Knowledge Center and only the help for your installed product:
- In a browser, go to the help download site.
- In the kcci_product_help directory, download the compressed file that
corresponds to your installed product and its version.
- Extract the contents of the compressed file on the intranet 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
- 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
If a Java error occurs when you start the server, see No JAVA_HOME defined error.
- After the IBM Knowledge Center is started, it is
available in a browser at this default URL: http://<server_name>:9090/kc. 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: 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 about starting, stopping, and configuring the IBM Knowledge Center, see the instructions in this file in the extracted content:
KnowledgeCenter/knowledgecenter_instructions.html.