orchestrator
2023.10
false
Orchestrator Installation Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Oct 3, 2024

Software Requirements

Server OS

Software

Compatible Versions

Windows Server

  • 2016
  • 2019
  • 2022

Databases

Software

Compatible Versions

SQL Server

  • 2014 Standard or Enterprise Edition
  • 2016 Standard or Enterprise Edition
  • 2017 Standard or Enterprise Edition
  • 2019 Standard or Enterprise Edition
  • 2022 Standard or Enterprise Edition
  • Azure SQL Database
  • Amazon RDS for SQL Server
  • Google Cloud SQL for SQL Server
Note: If you are considering installing Insights, make sure that your database supports both columnstore indexes and JSON functions.

UiPath High Availability Add-on

  • All Versions
Note: Required only for supported HA installations.
Important:

Multi-node Orchestrator deployments use the RESP (Redis Serialization Protocol) for communication, and thus can be configured using any solution relying on this protocol.

HAA is the only such solution supported by UiPath.

Logging & Visualization

Note: The below software is not explicitly required, but is recommended for logging & visualization purposes.

Software

Compatible Versions

Elasticsearch

  • 7.0 - 8.x

Check the official Elasticsearch End-of-Life dates and support matrix.

Starting with version 7.16.2, Elasticsearch no longer provides Windows MSI installer packages. Any later versions must be installed via .zip package.

We recommend a version greater than 7.16.2, but you can enable previous versions of Elasticsearch (installed via MSI) by using these parameters:

Kibana

  • 7.0 - 8.x

Browsers

Orchestrator only supports evergreen browsers:
BrowserSupported versions
Google Chromelatest two versions
Mozilla Firefoxlatest two versions
Microsoft Edgelatest two versions
Apple Safarilatest version

Deployment

Software

Compatible Versions

WebDeploy

3.5+

64bit version

Please note that this is required only for PowerShell script installations, such as the Azure one.

Windows PowerShell

5.1+

To download Windows PowerShell version 5.1, visit this link and install Windows Management Framework 5.1. For additional help, see the Windows PowerShell 5.1 installation documentation.

Software Frameworks

Software

Compatible Versions

.NET Framework

4.7.2+

ASP.NET Core Module

  • 6.0.x
  • 8.0.x
Note: ASP.NET Core IIS Module 8.0.x is available for download here as part of the Hosting Bundle.
Only the core needs to be installed, no runtime(s), which is done by running the installer from the command-line using OPT_NO_RUNTIME=1.
However, if you want to also install Test Manager, then ASP.NET Core must be installed including the runtime. Run the installer without the OPT_NO_RUNTIME=1 option to achieve this.

Web Servers

Software

Compatible Versions

IIS

10+

IIS Modules - URL Rewrite

2.1+

Virtualization Platforms

Note: Any platform that can create a Windows Virtual Machine can be used as well.

Software

Compatible Versions

Citrix XenDesktop

7.6+

Microsoft Hyper-V

2016+

VMWare vSphere

6+

Credential Stores

Note: The below items are not required for use of Orchestrator, but optional integrations.

Software

Compatible Versions

Dependencies

CyberArk®

  • Central Provider 12.6
  • Digital Vault 9.6 and later
  • Application Password SDK 9.7 and later.

Azure Key Vault

  

HashiCorp Vault

  • Open Source 1.5.0 and later
  • Enterprise 1.5.0 and later
  • Cloud (HCP Vault)
 

BeyondTrust

  • 21.3+
 
Note:

For additional details on the CyberArk® Credential Provider system requirements, refer to CyberArk® documentation.

If you are using another credential store via a plugin in Orchestrator you must verify that you meet all the dependencies and requirements of the respective plugin.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.