Download Help Center

The ALM Octane Help Center provides you with comprehensive user assistance. We recommend that you use the online version of the Help Center for the most recent updates available. If your organization has restrictions that prevent you from using the online Help Center, switch to the local mode, and save the Help Center files locally on your ALM Octane server.

Access the local help by default

For users to access the Help Center locally, site admins can do the following: 

  1. Stop the ALM Octane server on the ALM Octane machine.

  2. Download the help package octane-help.zip.

    Note: For earlier versions, see Earlier Help Center Versions.

    Extract to the following location on the ALM Octane server:

    Operating system Path Default path
    Linux <install_dir>/webapps/root/Help/WebUI /opt/octane/webapps/root/Help/WebUI
    Windows <install_dir>Webapps\root\Help\WebUI C:\octane\Webapps\root\Help\WebUI
  3. Start the ALM Octane server.

  4. Open ALM Octane Settings and set the EXTERNAL_HELP_URL configuration parameter to false.

  5. Restart the ALM Octane server.

Back to top

Switch back to the Help Center on the cloud

For users to access the Help Center on the cloud, site admins can do the following:

  1. Restart the ALM Octane server on the ALM Octane machine.

  2. Open ALM Octane Settings and set the EXTERNAL_HELP_URL configuration parameter to true.

  3. Restart the ALM Octane server.

Back to top