Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Offline single-node installation

This page explains how you can perform an offline Automation Suite installation with a single-node setup.

Overview

🚧

Important!

Hardware and software prerequisites must be completed before proceeding with the installation.
Hardware and software requirements

Use the offline installation steps in this document when deploying UiPath Automation suite in a airgapped environment with no access to the internet. If deploying an environment where the machines have internet access we recommend using the online installation steps which are optimized for that case.

The installation process has the following general steps:

Step

Description

Step 1: Download the installation packages

This step needs to be performed from a machine with access to internet and to the air-gapped machines where Automation Suite will be deployed. While these are finishing downloading, you can continue to some of the next steps.

This can be done from a Linux or windows machine.

Step 1.1: Downloading the install package
Step 1.2: Getting all downloaded files on the machine

Step 2: Configure the installation

The interactive install wizard gathers inputs for most common install options and generate a configuration file that will be used during the installation.
Step 2.1: Configuring the installation: basic configuration

The default install configuration includes the products used in core automation and a shared SQL server to be used by all products. To customize the products installed or have separate SQL servers used for specific products, you can do so by editing the configuration file.
Step 2.2: (Optional) Configuring the installation: advanced configuration (optional)

Step 3: Running the installation

Run the installation.
Once the installation is complete, you can start using the cluster.
Step 3: Running the installation

Step 4: Installation complete

You have completed the installation successfully.
To access the newly created cluster and suite, see Accessing Automation Suite. At this point, you can access the newly created cluster and suite.

 

Step-by-step guidance

Blue background steps are performed on the machine with internet access.
Green background steps are performed on the machines where the installation suite is being deployed.

 

Step 1: Downloading the installation package and getting the files on the machine

Step 1.1: Downloading the installation package


This step needs to be run on a machine with internet access and access to the machines in the air-gapped environment where UiPath Automation suite will be installed.

📘

Note:

This machine can be Linux or Windows. The commands in this guide are for RHEL-based OS. For Windows or other OSes, adjust for equivalent commands specific to those environments.

 

ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 
For Linux machines
 
  • The first step is to get the required files to start the install process and trigger the download of the installation bundles so they can happen in parallel while configuring the install.

  • Connect to a machine with internet access and run command to get the interactive wizard file:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>
  • Download the required packages (please keep the ' (single quotes) around the link):
  • sudo yum install wget -y
    wget -O ~/installUiPathAS.sh 'https://download.uipath.com/automation-suite/installUiPathAS.sh'
    wget -O ~/sf-installer.zip 'https://download.uipath.com/automation-suite/installer.zip'
    wget -O ~/sf.tar.gz 'https://download.uipath.com/automation-suite/sf.tar.gz'
    
  • The last 2 files take some time to download as they are large in size.

  • (Optional) To use Document Understanding, download the following bundles:
  • wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du.tar.gz'
    wget -O ~/du2110-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du2110.tar.gz'
    Note: Not following this optional step limits the functionality of the Document Understanding services.
  • (Optional) To use Computer Vision, download the following bundle:
  • wget -O ~/cv-ondemand.tar.gz 'https://download.uipath.com/automation-suite/cv.tar.gz'
    Note: Not following this optional step prevents access to the Computer Vision services.

For Windows machines
 
Download the packages from the links below:
Go to the first target machine for installation
 
  • Run the following command:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key, run the following command:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>

 

Step 1.2: Getting all downloaded files on the machine


Make sure to take the following steps:

  • Check that all files finished downloaded on the machine with internet access;
  • Create the target folder on the machine;
  • Copy the files from the online machine to the target machine.
ON THE MAIN MACHINE OF THE CLUSTER
 
Create the installation folder
 
  • Run the following command:
  • sudo su -
    mkdir -p /opt/UiPathAutomationSuite/
    chmod -R 755 /opt/UiPathAutomationSuite
    mkdir -p /uipath/tmp
    chmod -R 777 /uipath/tmp
ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 
Copy the files to the first node
 
  • From the machine with internet access, copy the files to the installation folder on the target machine, and the offline bundle(s) to the /uipath/tmp folder.

  • scp ~/installUiPathAS.sh ~/sf-installer.zip <username>@<node dns>:/uipath/tmp
    scp ~/sf.tar.gz <username>@<node dns>:/uipath/tmp/
  • (Optional) To use Document Understanding, copy the following bundles to the /uipath/tmp folder.
  • scp ~/du-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    scp ~/du2110-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Document Understanding services.
  • (Optional) To use Computer Vision, copy the following bundle to the /uipath/tmp folder.
  • scp ~/cv-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Computer Vision services.

 

Step 2: Configuring the installation

Step 2.1: Basic configuration


ON THE MAIN MACHINE OF THE CLUSTER
 
Add prerequisites folder to the current PATH
 
  • The interactive installer requires jq and our offline bundles already includes it. Run the following commands to add it to PATH: (make sure you are still root)
  • 
    mv /uipath/tmp/installUiPathAS.sh /uipath/tmp/sf-installer.zip /opt/UiPathAutomationSuite
    cd /opt/UiPathAutomationSuite
    unzip ./sf-installer.zip -d .
    chmod +x ./bin/jq
    export PATH=${PATH}:/opt/UiPathAutomationSuite/bin
Provide permissions to Installer Folder
 
  • It is required to give adequate permissions to the /opt/UiPathAutomationSuite folder where the install scripts are placed and going to be executed.
    Installer will also create some files (output.json) after execution of each stage.
    Run the following command to provide the permissions:
  • chmod -R 755 /opt/UiPathAutomationSuite
Run the interactive install wizard to configure the install options
 
  • Interactive wizard will guide through the configuration steps and generate the config which can be then customized and used through the remaining install steps
Run the script to begin interactive wizard
  • Run the following command
  • chmod +x ./installUiPathAS.sh
    ./installUiPathAS.sh
Follow the steps in the wizard
Screen-by-screen sequence
  • Enter the option for single-node.

  •  
  • Select option for Airgapped.

  •  
  • Specify the URL for the cluster (DNS hostname) and the SQL Server information as shown below:

  •  
  • Config will be generated with a folder as shown in the following image.

  •  
As soon as you generate the configuration file and the folder, you can exit the wizard and proceed with the remaining steps below to complete installation.

 

Step 2.2: (Optional) Advanced configuration


By running the installation using the default configuration, you are opting to run our default experience. You will install our core platform, Orchestrator, Insights, Test Manager, Action Center, Automation Ops, Apps, and Automation Hub.

At this step, you can directly edit the cluster_config.json for advanced configuration settings in the UiPathAutomationSuite folder. You can enable additional products, disable any of the default products, configure your SQL DBs and their respective connection strings, and certificates. For multi-node, we enable High Availability by default - you can disable.

Open the file using vim or your favorite editor.

For advanced configuration, you can follow the following instructions: Advanced installation experience.

 

Step 3: Running the installation


Make sure you copied the downloaded files on the main offline machine, where you performed the configuration, in the install folder created by the install wizard.

Accept License Agreement
 

Before running the installation, please read the License Agreement.
In order to accept the license agreement, choose one of the following methods:

  • Option 1 (Environment Variable)
  • Set the LICENSE_AGREEMENT environment variable to accept by executing the following command:
    export LICENSE_AGREEMENT=accept
  • Option 2 (Inline parameter)
  • Alternatively, append --accept-license-agreement to every execution of install-uipath.sh.

Running the installation command
 
Run the installation commands to execute the offline bundle (estimated duration: 2h30min - 3h30min):
cd /opt/UiPathAutomationSuite
./install-uipath.sh -i ./cluster_config.json -o ./output.json -a --offline-bundle /uipath/tmp/sf.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement
  • For help you can run ./install-uipath.sh -h --accept-license-agreement.
Loading the optional bundles commands
 
To load the optional Document Understanding bundles, execute the following commands:
./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du2110-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
To load the optional Computer Vision bundle, execute the following command:
./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement

This document focuses on -a command argument as this caters to need of installing all the required components.

Installing Task Mining
 
Please note, if you install Task Mining on single node, you need to run an additional set of steps.
    Follow the Task Mining installation guide to complete the steps for Task Mining.
     
    Installing AI center
     
    Please note, if you only installed AI Center, we recommend resizing the PVC to 200 immediately after the installation to avoid downtimes. For more information on this, check Resizing PVC for AI Center.

 

Step 4: Installation complete


📘

Note:

You have completed the installation successfully.

To access the newly created cluster and suite, see Accessing Automation Suite.

Updated 29 days ago


Offline single-node installation


This page explains how you can perform an offline Automation Suite installation with a single-node setup.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.