How to install the IBM Documentation Offline intranet server for use with IBM Engineering Lifecycle Management

Steps

1. Open a support case to request for the IBM Documentation Offline intranet download link. Download the IBM Documentation Offline intranet package.
2. Download and install Node.js from the Downloads page; version 16 or higher is required. (Example: Download and run node-v18.16.0-x86.msi)

1. Extract the IBM Documentation Offline intranet package into a location of your choosing.
2. In the extracted folder, update the docs.properties file to specify the http and https port (default is 9080 and 9443). 
3. The location where the documentation content is extracted to, is defined in a property called "data.location" in the docs.properties file. The default location is "data.location=./data". You can accept the default, or update the location to a folder of your choosing. The path can be either absolute path or the relative path.
4. Start the application with startDocs.sh or startDocs.bat files.
5. Confirm that the following URL is accessible:
      https://<server>:<port>/docs/en/products
6. Navigate to IBM Engineering Lifecycle Management documentation and select the version you would like to deploy.
7. Click Offline Docs or Downloaded link under the table of contents section to download the help content package. Ensure you are logged in. If the link does not exist, logout and login again in a new browser session or try a Private browsing session.
   Example: 
              
8. Use the unpackProductData.sh or unpackProductData.bat files to unpack your documentation. 
   Linux:

   ./unpackProductData.sh /path/to/data/SSYMRC_7.0.2_20221207.zip

   Windows:

   .\<ibm-docs-installation-path>\unpackProductData.bat <path-to-help-repo-file>\SSYMRC_7.0.2_20221207.zip
9. Stop your docs application:
   Linux: stopDocs.sh
   Windows: Close the npm cmd terminal or press CTRL+C within the npm cmd terminal.
   
10. Start the application again with the startDocs.sh or startDocs.bat files.

1. Go to the Advanced Properties page (https://<server>:<port>/<app>/admin#action=com.ibm.team.repository.admin.configureAdvanced). The Advanced Properties page applies for jts, ccm, qm, rm, dcc, gc. The applications lqe, ldx, and rs do not have Help Content configuration.
2. Update the "Web Help URI" in the Advanced Properties page to the product documentation URL.
   You can find the URL by going to https://<server>:<port>/docs/en/products and click the product documentation that was installed, then copy the URL from the browser address bar. (Example: https://<server>:<port>/docs/en/elm/7.0.2)
3. Save the configuration.
4. To access the documentation for each of the applications, click the question mark icon on the application web UI. Then, click the Help Contents link.