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.

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:\octane.

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

For details, see Deploy ALM Octane.

Back to top

Configuration

Configure ALM Octane by editing these files with your site's settings: 

  • setup.xml for initial configuration
  • octane.yml for ongoing configuration

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

For details, see Configure initial site settings and Configure other settings.

If you have previously installed ALM Octane on this machine, select Start > ALM Octane > Update ALM Octane Settings. For details, see Update settings.

Back to top

Initialization

Select Start > ALM Octane > Initialize ALM Octane Server.

This also starts the server.

For details, see Initialize 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

Cluster configuration (optional)

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

Back to top