Subscribe
UiPath Installation and Upgrade
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Installation and Upgrade Guide
UiPath Installation and Upgrade
Overview
UiPath Action Center
UiPath Activities
UiPath AI Center
UiPath Apps
UiPath Automation Cloudâ„¢
UiPath Automation Hub
UiPath Automation Ops
UiPath Automation Suite
UiPath Chatbot Connector - Preview
UiPath Connectors
UiPath Customer Portal
UiPath Data Service
UiPath Developer
UiPath Document Understanding
UiPath Insights
UiPath Installation and Upgrade
UiPath Integrations
UiPath Marketplace
UiPath Orchestrator
UiPath Process Mining
UiPath Release Notes
UiPath Robot
UiPath Studio
UiPath StudioX
UiPath Task Capture
UiPath Task Mining
UiPath Test Suite
v2021.10
v2020.4
deprecated
v2020.10
v2021.4
v2021.10
stable
Home
UiPath Installation and Upgrade Guide
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
UiPath Installation and Upgrade Guide
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Getting Started
About this guide
Compatibility Matrix
Orchestrator Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
Configuring the Firewall
Finding the .NET Framework Version
Creating an Index Pattern to Connect to Elasticsearch
Server Roles and Features
Using a Certificate for the HTTPS Protocol
About Deployment
Web Server on a Single Machine
Multi-Node Deployment
High Availability
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Orchestrator Best Practices
Security Best Practices
Deployment and Configuration Considerations
Encrypting the SQL Server
Disabling the HTTP Method Override Request
Using the FileSystem Storage Allowlist Securely
Performance Best Practices
Maintenance Considerations
Orchestrator Installation
📖 Installation Considerations
About Installation
The Windows Installer
Command Line Parameters
Azure App Service Installation
Webhooks Service Installation
Publish-Orchestrator.ps1 Parameters
Publish-IdentityServer.ps1 Parameters
Publish-Webhooks.ps1 Parameters
Azure Marketplace Deployment
AWS Deployment
âš™ Platform Configuration Tool
âš™ UiPath.Orchestrator.dll.config
Encrypting UiPath.Orchestrator.dll.config Sections
Overriding Configuration via Environment Variables
âš™ Web.Config
Unlocking Web.Config Sections
âš™ Webhooks AppSettings.json
Encrypting AppSettings.Production.json
About Troubleshooting
Orchestrator Installation Troubleshooting
Opting Out of Telemetry
Orchestrator Updating
📖 Upgrade Considerations
About Updating and Migrating
Migrating Elasticsearch Indices
Changing the Orchestrator / Identity Server URL
Updating Using the Windows Installer
Updating Using the Azure Script
Backup and Restore
Orchestrator Backup and Restore
Backup Configuration Files and NuGet Packages
Identity Server
Hardware and Software Requirements
Prerequisites for Installation
Installation
âš™ Identity Server AppSettings.json
Encrypting AppSettings.Production.json
Maintenance Considerations
About Troubleshooting
Identity Server Troubleshooting
Insights
Hardware and Software Requirements
Installation
Modifying Insights Configurations
Upgrading
Troubleshooting
Support
High Availability Add-on
Hardware and Software Requirements
Installation
Alerts and Monitoring
Active/Active Disaster Recovery Installation
Upgrading
Studio
Hardware and Software Requirements
Install Studio
Services Studio Connects To
Common Installation Errors
Activate Studio
About Licensing
Update Studio
Command Line Parameters
Supported Applications and Technologies
Enabling Gmail for Email Activities
Opting Out of Telemetry
Extensions
Extension for Chrome
Extension for Firefox
Extension for Edge (Legacy)
Extension for the New Edge Browser
Extension for Java
Extension for Silverlight
Extension for Citrix
Extension for Windows Remote Desktop
Extension for VMware Horizon
Excel Add-in
SAP Solution Manager Plugin
Robot
Hardware and Software Requirements
Installing the Robot
AWS Deployment
Azure Marketplace Deployment
Deploying Unattended Robots - Community License
Deploying Unattended Robots - Enterprise License
Installing Terraform
Updating the Robot
Setting Up Windows Server for High-Density Robots
Services the Robot Connects to
UiPath.Settings File Description
Task Capture
Hardware Requirements
Software Requirements
Installation
Command Line Parameters
Task Mining
Hardware and Software Requirements
Installation
Test Manager
Hardware Requirements
Software Requirements and Prerequisites
Installation
Test Manager Config File Encryption
Test Manager Provisioning Tool
Silent Install
Test Manager Deployment in Azure Marketplace
Authentication
Test Manager SDK
Troubleshooting
Process Mining
Hardware and Software Requirements
Server Installation
Updating the License
Deploying apps and discovery accelerators
Deploy a Release
End User Administration
Cache Generation
Environments
Deploying the UiPath Process Mining Profiler
Deploying the Basic Connector
Updating UiPath Process Mining
Updating a Customized Version of AppOne
Installing a Training Environment
Server Configuration
Using a Git Repository
Backup
About Telemetry
Creating Accounts for Developers
Set up Single Sign-On through Azure Active Directory
Set up Single Sign-On through Integrated Windows Authentication
Set up Single Sign-on through SAML
Set up LDAP
Set up a Credential Store
Set up Audit Logs
Two-Factor Authentication
Action Center
Software Requirements
Hardware Requirements
Prerequisites for Installation
Installation
Command Line Parameters
Opting Out of Telemetry
Action Center: Azure PaaS Installation
Getting Started
About this guide
Compatibility Matrix
Orchestrator Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
Configuring the Firewall
Finding the .NET Framework Version
Creating an Index Pattern to Connect to Elasticsearch
Server Roles and Features
Using a Certificate for the HTTPS Protocol
About Deployment
Web Server on a Single Machine
Multi-Node Deployment
High Availability
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Orchestrator Best Practices
Security Best Practices
Deployment and Configuration Considerations
Encrypting the SQL Server
Disabling the HTTP Method Override Request
Using the FileSystem Storage Allowlist Securely
Performance Best Practices
Maintenance Considerations
Orchestrator Installation
📖 Installation Considerations
About Installation
The Windows Installer
Command Line Parameters
Azure App Service Installation
Webhooks Service Installation
Publish-Orchestrator.ps1 Parameters
Publish-IdentityServer.ps1 Parameters
Publish-Webhooks.ps1 Parameters
Azure Marketplace Deployment
AWS Deployment
âš™ Platform Configuration Tool
âš™ UiPath.Orchestrator.dll.config
Encrypting UiPath.Orchestrator.dll.config Sections
Overriding Configuration via Environment Variables
âš™ Web.Config
Unlocking Web.Config Sections
âš™ Webhooks AppSettings.json
Encrypting AppSettings.Production.json
About Troubleshooting
Orchestrator Installation Troubleshooting
Opting Out of Telemetry
Orchestrator Updating
📖 Upgrade Considerations
About Updating and Migrating
Migrating Elasticsearch Indices
Changing the Orchestrator / Identity Server URL
Updating Using the Windows Installer
Updating Using the Azure Script
Backup and Restore
Orchestrator Backup and Restore
Backup Configuration Files and NuGet Packages
Identity Server
Hardware and Software Requirements
Prerequisites for Installation
Installation
âš™ Identity Server AppSettings.json
Encrypting AppSettings.Production.json
Maintenance Considerations
About Troubleshooting
Identity Server Troubleshooting
Insights
Hardware and Software Requirements
Installation
Modifying Insights Configurations
Upgrading
Troubleshooting
Support
High Availability Add-on
Hardware and Software Requirements
Installation
Alerts and Monitoring
Active/Active Disaster Recovery Installation
Upgrading
Studio
Hardware and Software Requirements
Install Studio
Services Studio Connects To
Common Installation Errors
Activate Studio
About Licensing
Update Studio
Command Line Parameters
Supported Applications and Technologies
Enabling Gmail for Email Activities
Opting Out of Telemetry
Extensions
Extension for Chrome
Extension for Firefox
Extension for Edge (Legacy)
Extension for the New Edge Browser
Extension for Java
Extension for Silverlight
Extension for Citrix
Extension for Windows Remote Desktop
Extension for VMware Horizon
Excel Add-in
SAP Solution Manager Plugin
Robot
Hardware and Software Requirements
Installing the Robot
AWS Deployment
Azure Marketplace Deployment
Deploying Unattended Robots - Community License
Deploying Unattended Robots - Enterprise License
Installing Terraform
Updating the Robot
Setting Up Windows Server for High-Density Robots
Services the Robot Connects to
UiPath.Settings File Description
Task Capture
Hardware Requirements
Software Requirements
Installation
Command Line Parameters
Task Mining
Hardware and Software Requirements
Installation
Test Manager
Hardware Requirements
Software Requirements and Prerequisites
Installation
Test Manager Config File Encryption
Test Manager Provisioning Tool
Silent Install
Test Manager Deployment in Azure Marketplace
Authentication
Test Manager SDK
Troubleshooting
Process Mining
Hardware and Software Requirements
Server Installation
Updating the License
Deploying apps and discovery accelerators
Deploy a Release
End User Administration
Cache Generation
Environments
Deploying the UiPath Process Mining Profiler
Deploying the Basic Connector
Updating UiPath Process Mining
Updating a Customized Version of AppOne
Installing a Training Environment
Server Configuration
Using a Git Repository
Backup
About Telemetry
Creating Accounts for Developers
Set up Single Sign-On through Azure Active Directory
Set up Single Sign-On through Integrated Windows Authentication
Set up Single Sign-on through SAML
Set up LDAP
Set up a Credential Store
Set up Audit Logs
Two-Factor Authentication
Action Center
Software Requirements
Hardware Requirements
Prerequisites for Installation
Installation
Command Line Parameters
Opting Out of Telemetry
Action Center: Azure PaaS Installation
Only admins can see this
Enable it for everyone
Getting Started
About this guide
Compatibility Matrix
Orchestrator Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
View All 4
Orchestrator Best Practices
Security Best Practices
Performance Best Practices
Orchestrator Installation
📖 Installation Considerations
About Installation
The Windows Installer
View All 12
Orchestrator Updating
📖 Upgrade Considerations
About Updating and Migrating
Updating Using the Windows Installer
View All 5
Identity Server
Hardware and Software Requirements
Prerequisites for Installation
Installation
View All 6
Insights
Hardware and Software Requirements
Installation
Upgrading
View All 5
High Availability Add-on
Hardware and Software Requirements
Installation
Upgrading
Studio
Hardware and Software Requirements
Install Studio
Activate Studio
View All 9
Robot
Hardware and Software Requirements
Installing the Robot
Updating the Robot
View All 6
Task Capture
Hardware Requirements
Software Requirements
Installation
View All 4
Task Mining
Hardware and Software Requirements
Installation
Test Manager
Hardware Requirements
Software Requirements and Prerequisites
Installation
View All 6
Process Mining
Hardware and Software Requirements
Server Installation
Updating the License
View All 21
Action Center
Software Requirements
Hardware Requirements
Prerequisites for Installation
View All 6