Deploy ALM Octane

This section describes how to deploy the files necessary for installing an ALM Octane server.


Installing ALM Octane does the following:

  • Creates the correct folder structure and copies all the files to the right locations.

  • Installs the ALM Octane service so that the operating system recognizes it.

Back to top


Before installing:

  • Verify that your server fulfills all prerequisites. For details, see Prerequisites.

  • Review security considerations in the knowledge base article KM02707977.

Back to top


  1. Download the ALM Octane package.

  2. Install the ALM Octane package, by running as an administrator:


    Click Next.

  3. In the setup dialog, set the following:

    Installation folder

    The folder in which to install ALM Octane. The default is C:\octane.

    Do not enter a name with spaces for the folder.

    Service user

    Whether the service should use the local system account or a specific user.

    Service user domain

    The domain of the user that will start the ALM Octane service.

    Available when the Service user is Specific user.

    Service user name

    The name of the user that will start the ALM Octane service.

    This user must have administrative permissions if using Microsoft SQL Server, and must be a local administrator.

    Available when the Service user is Specific user.


    Password for the user that will start the ALM Octane service.

    Available when the Service user is Specific user.

    Click Next. The installation starts deploying files.

  4. Click Finish.

  5. Verify that you have full administrator permissions for the following:

    Default folder Description

    ALM Octane installation folder and all its sub-directories and files. These files are used for configuring the server.


    The repository folder, and its site and spaces sub-directories.

  6. Cluster configuration:

    • The repository folder has to be a shared folder visible to all cluster nodes.

    • It is important that you enter the repository path using the same path name on all nodes. For example, you cannot have the path on the first server node defined as C:\octane\repo and on additional nodes defined as C:\opt\octane\repo.

    • If the repository is not located on a remote, dedicated machine, the repository location cannot be C:\octane.

  7. C:\octane\log Log file folder.
  8. If planning to install ALM Octane on additional cluster nodes, perform the steps described under Deploy in cluster environment.

Back to top

Deploy in cluster environment

  1. Configure the IP addresses (or fully qualified domain names) of the cluster nodes. Configure the node IP addresses or fully qualified domain names in the octane.yml file. For details, see Configure other settings.

  2. Verify ports are open in your firewall. When deploying ALM Octane over a cluster, ALM Octane needs to communicate between the nodes in the cluster located on port 5701. Therefore, make sure that your firewall enables communication between the nodes of the cluster on the specified port.

Back to top

Next steps: