Installation flow

This document describes the overall flow for installing the ALM Octane server on Windows.

Prerequisites

Verify your system meets hardware and software requirements.

This includes setting up permissions, opening ports, database configuration, and more.

You need three separate server machines. 

  • ALM Octane server

  • Database server

  • Elasticsearch server

For details, see Prerequisites and Best practices.

Note: We recommend you review security considerations in the knowledge base article KM02707977. This article contains Instructions on how to set up a secure configuration for ALM Octane.

Back to top

Deployment

Deploy ALM Octane on a machine dedicated for the ALM Octane server on Windows.

ALM Octane is deployed using an installation program.

The default deployment path is C:\Program Files\octane.

The command to deploy is: octane-onprem-<version>.exe

For details, see Deploy ALM Octane and Best practices for deploying ALM Octane.

Back to top

Configuration

  1. Edit the octane.conf file with your site's settings for initial configuration.

  2. (Optional) Depending on your needs, configure optional configuration files:

    • elasticsearch-security.conf to configure secure Elasticsearch.

    • proxy.conf to use a proxy server.

    • ldap.conf to use LDAP authentication.

    • sso.conf to use SSO authentication.

    The path to these files is C:\Program Files\octane\conf.

For details, see Configure site settings.

Note: The .conf files do not support use of backslashes (\) in paths. Instead, use a regular slash (/) or double-slash (//).

Back to top

Start the server

Select Start > ALM Octane > Start ALM Octane Server.

For details, see Start the ALM Octane server.

Back to top

Verify and log in

Verify that ALM Octane was properly installed.

Log into ALM Octane. For details, see Log in to ALM Octane.

Back to top

Configure cluster (optional)

After starting the server on the first machine, configure and initialize each additional cluster node. For details, see Cluster installation flow.

Back to top

Next steps: