安装模式

在 Windows 操作系统上安装

UiPath provides two installers for Windows. You can download them from the Resource Center in UiPath Automation Cloud or from the Product Downloads section in Customer Portal.

About 32-bit and 64-bit versions

• Before the 2021.4 release, Studio and Robot were 32-bit applications. However, from version 2021.4 onward, a 64-bit installer is the default.

• Starting with version 2023.4, a 32-bit installer is no longer provided, and the UiPathPlatformInstaller.exe is discontinued beginning with version 2021.4.
• To update existing 32-bit or 64-bit UiPathStudio.msi and UiPathPlatformInstaller.exe installations on 64-bit operating systems, use UiPathStudio.msi.
• The default installation path for pre-2021.4, 32-bit installation on a 64-bit system was C:\Program Files (x86)\UiPath\Studio. Upgrading to 64-bit installers migrates the installation to the C:\Program Files\UiPath\Studio folder. Installations that use custom paths do not change their directory after update.

About quick and custom installations

您可以通过在安装向导中选择“快速”选项（不需要管理员权限），以默认配置为当前用户执行安装，也可以通过选择“自定义”选项来配置安装（每台计算机安装需要管理员权限）。

备注：

如果您使用的是 Microsoft Windows Server，则每用户安装可能无法成功完成。如果发生错误，提示已设置策略来阻止安装，若您是计算机的管理员，则可以执行以下任一操作：

• 打开注册表编辑器，然后在注册表键 HKLM\Software\Policies\Microsoft\Windows\Installer 中配置策略 DisableMSI = 0，为所有应用程序启用 Windows 安装程序。
• 通过使用“自定义”选项进行安装，以按照计算机执行安装。

The following table summarizes the differences and similarities between quick and custom installations.

	快速入门	自定义
安装上下文	按用户	按用户或计算机
支持的机器人安装类型	用户模式	有人值守安装的用户模式（按用户和按计算机）。 无人值守安装的服务模式（按计算机）。
安装所需的管理员权限	否	仅对于每台计算机安装是必需的。
安装目录	%LocalAppData%\Programs	可以选择自定义位置。默认位置为： %LocalAppData%\Programsfor per-user installations. %ProgramFiles%for per-machine installations.
使用社区版许可激活	支持	支持
使用企业版许可激活	支持	支持
需要管理员权限 用于连接到 Orchestrator	否	Required only for the Service-Mode robot
使用交互式登录连接到 Orchestrator。	支持	支持 1
使用计算机密钥连接到 Orchestrator	支持	支持
无人值守执行，无需用户登录	不支持	Supported only for the Service-Mode robot

1 - For the Service-Mode robot, you must first connect to Orchestrator using client credentials, and then you can use interactive sign-in to change the user who connects to Orchestrator.

使用 UiPath.Studio.msi

UiPath.Studio.msi is the Windows installer that targets mainly developers. When installed, the software package includes both the development environment (UiPath Studio), UiPath Robot, and UiPath Assistant to execute the developed workflows.

If you are looking to build, debug, and test automation on the same machine, use this installer.

Available installation options

• Quick installation - Installs a default configuration in the %localappdata%\Programs\UiPath directory. The default configuration includes:

  • Studio、StudioX 和 Assistant

  • 用户模式机器人

  • StudioX Excel add-on (if you have Microsoft Excel already installed on your machine)

  • Chrome extension (if you have Google Chrome already installed on your machine)

  • Edge Chromium extension (if you have Microsoft Edge Chromium already installed on your machine)

  • JavaScript Robot 附加项

  • Microsoft 远程桌面扩展程序

• Custom installation - Allows you to select the components you want to install, and configure advanced settings. The installation path is %LocalAppData%\Programs for current user installations, and %ProgramFiles% for installations applicable to all users on the device.

Custom installation - available options

• Install for me only - Install your custom configuration in the user profile folder. No administrator privileges needed.

• Install for all users on this computer - Installs your custom configuration for all users on the machine. Needs administrator privileges.

Install for me only - available installation packages

• Automation Developer - Installs the following configuration, for running attended automations:

  • Studio、StudioX 和 Assistant

  • 用户模式机器人

• Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.

  • Assistant

  • 用户模式机器人

When you select an option, the Advanced Settings configuration becomes available, with the following options:

Advanced setting	描述
Installation Package	Orchestrator URL - the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account.
Extensions > Tools	StudioX Excel Addin UiPath JavaScript 机器人插件 UiPath Chrome 扩展程序 UiPath extension for Edge Chromium Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop
Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

Install for all users on this computer - available installation packages

• Automation Developer - Installs the following configuration, for running attended automations:

  • Studio、StudioX 和 Assistant

  • 用户模式机器人

• Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.

  • Assistant

  • 用户模式机器人

  When you select an option, the Advanced Settings configuration becomes available.

  Advanced setting	描述
  Installation Package	Installation Path - The destination folder for installation. Default path is %ProgramFiles%. License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch. Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account. Automatically Starts Assistant with Windows - Launches Assistant at Windows startup.
  Extensions > Tools	StudioX Excel Addin UiPath Java 扩展程序 UiPath JavaScript 机器人插件 UiPath Citrix 扩展程序 UiPath Chrome 扩展程序 UiPath extension for Edge Chromium Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop UiPath extension for VMware SAP Solution Manager - Available if you have the SAP connector for Microsoft is already installed on your machine. If selected, you need to provide the hostname or IP address for your SAP Solution Manager instance in the Host box.
  Extensions > Default download location	The download location for activity packages. Default location is %userprofile%.nuget\packages.
  Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
  安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

• Unattended Robot - Installs the following configuration, for running unattended automations:

  • Assistant

  • Robot in Service Mode

  When you select an option, the Advanced Settings configuration becomes available.

  Advanced setting	描述
  Installation Package	License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch. Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.configfile. Client Id and Client Secret - The client credentials from machine template objects. This pair produces a token, allowing unattended robots access to Orchestrator resources. Install UiPath Studio - If selected, installs Studio for design purposes.
  Extensions > Tools	StudioX Excel Addin UiPath Java 扩展程序 UiPath JavaScript 机器人插件 UiPath Citrix 扩展程序 UiPath extension for Chrome (*) UiPath extension for Edge Chromium (*) Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop UiPath extension for VMware SAP Solution Manager - Available if you have the SAP connector for Microsoft is already installed on your machine. If selected, you need to provide the hostname or IP address for your SAP Solution Manager instance in the Host box. (*) These options are selected by default.
  Extensions > Default download location	The download location for activity packages. Default location is %userprofile%.nuget\packages.
  Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
  安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

使用 UiPath.Robot.msi

UiPath.Robot.msi is typically installed on Windows machines that mainly execute automations. No development environment is attached to this installation, and thus, resource allocation is primarily for running robots. It includes UiPath Robot and UiPath Assistant.

Available installation options

• Quick installation - Installs a default configuration in the %localappdata%\Programs\UiPath directory. The default configuration includes:

  • Studio、StudioX 和 Assistant

  • 用户模式机器人

  • StudioX Excel add-on (if you have Microsoft Excel already installed on your machine)

  • Chrome extension (if you have Google Chrome already installed on your machine)

  • Edge Chromium extension (if you have Microsoft Edge Chromium already installed on your machine)

  • JavaScript Robot 附加项

  • Microsoft 远程桌面扩展程序

• Custom installation - Allows you to select the components you want to install, and configure advanced settings. The installation path is %LocalAppData%\Programs for current user installations, and %ProgramFiles% for installations applicable to all users on the device.

Custom installation: available installation packages

• Install for me only: Attended - Installs Robot and Assistant to run attended automations. Your custom configuration applies to the current user profile. No administrator privileges needed.

• Install for all users: Attended - Installs Robot and Assistant to run attended automations. Your custom configuration applies to all users on the machine. Needs administrator privileges.

• Install for all users: Unattended - Installs Robot to run unattended automations via Orchestrator, and installs Assistant for troubleshooting. Your custom configuration applies to all users on the machine. Needs administrator privileges.

Custom - available installation packages

• Install for me only: Attended - Installs Robot and Assistant to run attended automations.

  • Your custom configuration applies to the current user profile.

  • Robot is installed in User Mode.

  • No administrator privileges needed.

  When you select this option, the Advanced Settings configuration becomes available.

  Advanced setting	描述
  Installation Package	Orchestrator URL - the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account.
  Extensions > Tools	UiPath JavaScript Robot Add-on (*) UiPath extension for Chrome (*) UiPath extension for Edge Chromium (*) Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop (*) These options are selected by default.
  Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
  安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

• Install for all users: Attended- Installs Robot and Assistant to run attended automations.

  • Your custom configuration applies to tall users on the machine.

  • Robot is installed in User Mode.

  • Needs administrator privileges.

  • Automatically starts Assistant with Windows.

  When you select this option, the Advanced Settings configuration becomes available.

  Advanced setting	描述
  Installation Package	Installation Path - The destination folder for installation. Default path is %ProgramFiles%. License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch. Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account. Automatically Starts Assistant with Windows - Launches Assistant at Windows startup.
  Extensions > Tools	UiPath Java 扩展程序 UiPath JavaScript Robot Add-on (*) UiPath Citrix 扩展程序 UiPath extension for Chrome (*) UiPath extension for Edge Chromium (*) Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop UiPath extension for VMware (*) These options are selected by default.
  Extensions > Default download location	The download location for activity packages. Default location is %userprofile%.nuget\packages.
  Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
  安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

• Install for all users: Unattended- Installs Robot to run unattended automations via Orchestrator, and installs Assistant to troubleshoot issues.

  • Your custom configuration applies to tall users on the machine.

  • Robot is installed in Service Mode.

  • Needs administrator privileges.

  When you select this option, the Advanced Settings configuration becomes available.

  Advanced setting	描述
  Installation Package	Installation Path - The destination folder for installation. Default path is %ProgramFiles%. License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch. Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Client Id and Client Secret - The client credentials from machine template objects. This pair produces a token, allowing unattended robots access to Orchestrator resources.
  Extensions > Tools	UiPath Java 扩展程序 UiPath JavaScript 机器人插件 UiPath Citrix 扩展程序 UiPath extension for Chrome (*) UiPath extension for Edge Chromium (*) Firefox 版 UiPath 扩展程序 UiPath extension for Microsoft Remote Desktop UiPath extension for VMware (*) These options are selected by default.
  Extensions > Default download location	The download location for activity packages. Default location is %userprofile%.nuget\packages.
  Extensions > Packages configuration	Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
  安全性	Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively. Disable Secured XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.

使用命令提示符

Installing Robot or Studio using command line parameters is useful for installation on multiple machines, for silent installations, and for saving system resources that a graphical wizard might consume. It also allows customized installation settings and integration with scripts.

重要提示：

To install the Robot using the command prompt, you need administrator privileges.

最佳实践

• To escape the "%" character in system variable names, such as %username%, use the following command:

  ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%

  备注：

  In PowerShell, no escaping is needed.

• When using Active Directory domain accounts, specify the domain name in the folder structure:

  C:\packages\^%UserDomain^%.^%Username^%

• To use paths that contain spaces, use quotes:

  • In Command Prompt, use double quotes:

    UiPathRobot.msi APPLICATIONFOLDER="C:\folder name"

  • In PowerShell, use single and double quotes:

    ./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'

Clean installations - command line parameters

These parameters are available when running the UiPath.Studio.msi or UiPath.Robot.msi from the command line.

命令	描述
/q	Installs the specified UiPath features silently, without displaying the user interface.
/l*vx <LogFile>	Generates an installer log file at the specified path. 如果您在安装过程中遇到困难，不管何种原因，均可将此文件发送给我们的支持团队。
ADDLOCAL	Allows selecting the features to install. Without this parameter, the following features are installed by default: Robot in Service Mode Default activity packages JavaScript Add-on 它支持以下选项： DesktopFeature Indicates that you want to install the Robot feature. Studio (exclusively for UiPath.Studio.msi) Installs Studio. Must be used together with the DesktopFeature parameter. ExcelAddin (exclusively for UiPath.Studio.msi) Installs the StudioX Excel Add-in. Must be used together with the Studio parameter. 机器人 Installs the Robot in User Mode or Service Mode, as well as the Assistant. Must be used together with the DesktopFeature parameter. RegisterService Required for Service Mode installations. Do not add it for User Mode installations. StartupLauncher Runs the Robot at Windows startup. Must be used together with the DesktopFeature parameter. Packages (exclusively for UiPath.Studio.msi) Installs the default activity packages. Must be used together with the Robot parameter. JavaBridge Installs the UiPath Java Bridge for a better integration and automation with Java applications. Adding this may increase the installation time. Must be used together with the Robot parameter. ChromeExtension Installs the Google Chrome Extension. Must be used together with the Robot parameter. FirefoxExtension Installs the Firefox extension. Must be used together with the Robot parameter. EdgeExtension Installs the Microsoft Edge Chromium-based Extension. Must be used together with the Robot parameter. CitrixClient Installs the UiPath Citrix Client Extension. Must be used together with the Robot parameter. Not available for per-user installations. JavaScriptAddOn Installs the Browser Embedding add-on. Must be used together with the Robot parameter. Cannot be used with elevated rights. SapPlugin (exclusively for UiPath.Studio.msi) Installs the SAP Solution Manager plugin. Requires the SAP Connector for Microsoft to be installed on your machine. On clean installs, you must also provide an address for the instance using the SAP_SOL_MAN_HOST parameter. Must be used together with the Studio parameter. Not available for per-user installations. VMwareExtension Installs the UiPath extension for VMware Horizon. Must be used together with the Robot parameter. Not available for per-user installations. WindowsRdpExtension Installs the UiPath extension for Windows Remote Desktop. Must be used together with the Robot parameter. LiveStreaming Installs the live streaming software (RealVNC) on the machine.
MSIINSTALLPERUSER	Enables you to install only for the current user. To install per user, add MSIINSTALLPERUSER=1. To install per machine, do not include this parameter. 以下选项在按用户安装中不可用：RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE。
SAP_SOL_MAN_HOST (exclusively for UiPath.Studio.msi)	The hostname or IP address of your SAP Solution Manager instance. Required for clean installations where the SapPlugin parameter was added in the ADDLOCAL option.
APPLICATIONFOLDER	用于在自定义位置安装 Robot。
NUGET_OPTIONS	For offline environments. If set to DisableOnlineFeeds, this parameter disables the online UiPath official and Community feeds for the Robot, and uses Orchestrator and local feeds exclusively. 备注： The URL feeds remain in the configuration files, but are ignored.
PACKAGES_FOLDER	Enables you to change the download location for your workflows and their dependencies. The chosen folder can be user-specific or accessible by all users on a machine. Without this parameter, the default download location is %userProfile%\.nuget\packages. Not available for per-user installations. Note: Make sure that all users that need to execute processes have read access to the new folder. Find out how to set up custom package folders and network paths. For installations on Windows Server machines that enable concurrent execution, you must provide paths that are specific to each user. Read more about using the same path for multiple robots. Find out how to change the download folder for packages after installation.
CUSTOM_NUGET_FEEDS	Enables you to add custom NuGet activities feeds for Studio and/or Robot. This command only adds or updates the existing list of feeds. It must be populated with key-value pairs of type string: Valid locations include online feeds, folder paths, and shared network drives. Make sure that the provided feeds are accessible by all users on a given machine. Separate feeds with semicolons (;). 例如： CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"
ENFORCE_SIGNED_EXECUTION	Optional. Enables you to enforce your Robots to execute only signed packages. Without this parameter, package signing is not enabled. It has the following options: 1 The Robot only handles packages signed by UiPath-verified authors or repositories. To add your own certificate as a trusted source, modify the nuget.config file. 0 No package signing rule is enforced on your Robot deployment. For more details, see Signing Packages.
CODE	向您的 Robot 实例授予许可。 Not available for per-user installations.
CLIENT_ID 和 CLIENT_SECRET	Automatically connects the Robot to Orchestrator using client credentials, while also installing it. 例如： UiPathRobot.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
CHROME_INSTALL_TYPE	允许您选择 Chrome 扩展程序的安装方法。 Needs admin rights. Without this parameter, the most appropriate method is selected automatically. It has the following options: POLICYOFFLINE The Chrome Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Chrome-Policy-Offline command using the SetupExtensions tool. POLICYONLINE The Chrome Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /ChromePolicyGlobal command using the SetupExtensions tool. MANUALPERMACHINE The Chrome Extension is installed for all users, the equivalent of calling the /ChromeGlobal command using the SetupExtensions tool. NATIVEHOSTONLY Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /ChromeNativeHostGlobal command using the SetupExtensions tool. 注意：旧的安装方法名称（STORE 和 GLOBAL）会保留下来，以保持向后兼容性。
EDGE_INSTALL_TYPE	Allows you to choose the installation method for the Edge extension. Needs admin rights. Without this parameter, the most appropriate method is selected automatically. It has the following options: POLICYOFFLINE The Edge Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Edge-Policy-Offline command using the SetupExtensions tool. POLICYONLINE The Edge Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /Edge-Chromium-PolicyGlobal command using the SetupExtensions tool. MANUALPERMACHINE The Edge Extension is installed for all users, the equivalent of calling the /Edge-Chromium-Global command using the SetupExtensions tool. NATIVEHOSTONLY Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /Edge-Chromium-NativeHostGlobal command using the SetupExtensions tool. 注意：旧的安装方法名称（STORE 和 GLOBAL）会保留下来，以保持向后兼容性。
DISABLE_SECURE_XAML	允许为安装为 Windows 服务的机器人禁用 XAML 文件的安全性。未受保护的 XAML 文件允许用户读取并修改流程文件和逻辑。 It has the following options: 0 The default option. Enables security for XAML files for Windows service Robots. 1 Disables security for XAML files for Windows service Robots.
SERVICE_URL	Allows you to define the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Required by User-Mode installations. Service-Mode installations ignore this parameter.
ORCHESTRATOR_URL	In clean installations, you can specify the main Orchestrator URL, used for retrieving auto-update information. For example: https://orchestrator.local/organizationName/tenantName.
TELEMETRY_ENABLED	Allows you to disable the usage data collection. It has the following options: 0 Disables the telemetry for Studio and Robot. 1 The default option. Enables the telemetry for Studio and Robot. Find out how to opt out of telemetry.
ENABLE_PIP	Allows you to enable the Robot session (Picture in Picture) functionality of the machine. It has the following options: 0 Default option. The Robot session capability is disabled. 1 Enables the Robot session capability.
INSTALLER_LANGUAGE	Enables you to select the display language of the installer. Without this parameter, the installer uses the language settings in Windows. It has the following options: 2052 中文 (简体) 12 法语 7 德语 17 日语 1 韩语 22 Portuguese (Portugal) 1046 葡萄牙语 (巴西) 25 俄语 10 Spanish (Spain) 2058 西班牙语 (墨西哥) 31 土耳其语
ASSISTANT_OPTIONS	Enables or disables the Marketplace widget for Assistant. It has the following options: Absent or EnableMarketplace The default option. Enables the widget. DisableMarketplace Disabled the widget.
ORCHESTRATOR_AUTO_SIGNIN	Enables automatic sign-in to your account. For User-Mode installations and environments configured to use the SSO with Azure Active Directory. Must be used together with the ORCHESTRATOR_URL parameter. It has the following options: 0 Disables the automatic sign-in. 1 Enables the automatic sign-in.
ENFORCE_DEFAULT_SERVICE_URL	Enforces the default service URL. For User-Mode installations. Must be used together with the ORCHESTRATOR_URL parameter. It has the following options: 0 Disables the enforcement of the default service URL. 1 Enables the enforcement of the default service URL.

Update or modifying existing installations - command line parameters

These parameters are available when running the UiPath.Studio.msi from the command line.

命令	描述
/q Not supported for changing an existing installation.	Updates the specified UiPath features silently, without displaying the user interface.
ADDLOCAL	Allows selecting the features to install. Without this parameter, the following features are installed by default: Robot in Service Mode Default activity packages JavaScript Add-on 它支持以下选项： DesktopFeature Indicates that you want to install the Robot feature. Studio (exclusively for UiPath.Studio.msi) Installs Studio. Must be used together with the DesktopFeature parameter. ExcelAddin (exclusively for UiPath.Studio.msi) Installs the StudioX Excel Add-in. Must be used together with the Studio parameter. 机器人 Installs the Robot in User Mode or Service Mode, as well as the Assistant. Must be used together with the DesktopFeature parameter. RegisterService Required for Service Mode installations. Do not add it for User Mode installations. LiveStreaming Installs the live streaming software (RealVNC) on the machine. See The Live Streaming feature. StartupLauncher Runs the Robot at Windows startup. Must be used together with the DesktopFeature parameter. Packages (exclusively for UiPath.Studio.msi) Installs the default activity packages. Must be used together with the Robot parameter. JavaBridge Installs the UiPath Java Bridge for a better integration and automation with Java applications. Adding this may increase the installation time. Must be used together with the Robot parameter. ChromeExtension Installs the Google Chrome Extension. Must be used together with the Robot parameter. FirefoxExtension Installs the Firefox extension. Must be used together with the Robot parameter. EdgeExtension Installs the Microsoft Edge Chromium-based Extension. Must be used together with the Robot parameter. CitrixClient Installs the UiPath Citrix Client Extension. Must be used together with the Robot parameter. Not available for per-user installations. JavaScriptAddOn Installs the Browser Embedding add-on. Must be used together with the Robot parameter. Cannot be used with elevated rights. SapPlugin (exclusively for UiPath.Studio.msi) Installs the SAP Solution Manager plugin. Requires the SAP Connector for Microsoft to be installed on your machine. On clean installs, you must also provide an address for the instance using the SAP_SOL_MAN_HOST parameter. Must be used together with the Studio parameter. Not available for per-user installations. VMwareExtension Installs the UiPath extension for VMware Horizon. Must be used together with the Robot parameter. Not available for per-user installations. WindowsRdpExtension Installs the UiPath extension for Windows Remote Desktop. Must be used together with the Robot parameter. LiveStreaming Installs the live streaming software (RealVNC) on the machine.
REMOVE	Disables a feature. 备注： Robot cannot be removed.
NUGET_OPTIONS Not supported for changing an existing installation.	For offline environments. If set to DisableOnlineFeeds, this parameter disables the online UiPath official and Community feeds for the Robot, and uses Orchestrator and local feeds exclusively. 备注： The URL feeds remain in the configuration files, but are ignored.
ENFORCE_SIGNED_EXECUTION Not supported for changing an existing installation.	Optional. Enables you to enforce your Robots to execute only signed packages. Without this parameter, package signing is not enabled. It has the following options: 1 The Robot only handles packages signed by UiPath-verified authors or repositories. To add your own certificate as a trusted source, modify the nuget.config file. 0 No package signing rule is enforced on your Robot deployment. For more details, see Signing Packages.
SERVICE_URL	Allows you to define the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Available when switching the Robot from Service Mode to User Mode, by not including the RegisterService parameter.
TELEMETRY_ENABLED Not supported for changing an existing installation.	Allows you to disable the usage data collection. It has the following options: 0 Disables the telemetry for Studio and Robot. 1 The default option. Enables the telemetry for Studio and Robot. Find out how to opt out of telemetry.
ASSISTANT_OPTIONS	Enables or disables the Marketplace widget for Assistant. It has the following options: Absent or EnableMarketplace The default option. Enables the widget. DisableMarketplace Disabled the widget.
DISABLE_SECURE_XAML Not supported for changing an existing installation.	允许为安装为 Windows 服务的机器人禁用 XAML 文件的安全性。未受保护的 XAML 文件允许用户读取并修改流程文件和逻辑。 It has the following options: 0 The default option. Enables security for XAML files for Windows service Robots. 1 Disables security for XAML files for Windows service Robots.

The live streaming feature

Starting with version 2024.10, the live streaming feature uses the RealVNC software, which comes bundled in the UiPath Robot and UiPath Studio 2024.10+ installers. Installing or upgrading to the 2024.10+ Robot using the GUI or the command prompt automatically installs RealVNC , unless the ADDLOCAL parameter is used. If you choose to use the ADDLOCAL parameter in a command prompt installation, you must add the LiveStreaming flag.

For example, the following UiPathRobot.msi command performs a custom installation or upgrade which also installs RealVNC, the software that is required for live streaming:

UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,LiveStreaming

在 Mac 上安装

Mac operating systems allow installing the Robot in User Mode and the Assistant. You cannot configure your own setup. The installation on MacOS is similar to the quick installation on Windows OS. The earliest compatible MacOS version is 10.15 (Catalina).

To install Assistant on Mac, you need to download the installation file (DMG) and run it, as you would do for any installation file on MacOS.

You can download the DMG file from two sources:

• Customer portal > Downloads > UiPath Assistant <LTS version>

• Automation Cloud™> Help icon > Downloads > Assistant for macOS

The available Apple processors that support installing Assistant are:

• Intel x64 - runs both macOS and Windows, which expands the range of software that can be used

• Apple Silicon ARM64 - based on ARM architecture

Although you cannot install Studio directly on Mac, you can execute attended, cross-platform automations through Assistant.

MacOS automations - particularities and limitations

• You cannot use local feeds. This means that only automations from the Orchestrator, specifically cross-platform ones, are available.

• The previous rule applies to the Marketplace Widget, namely it only displays and allows the execution of cross-platform automations that are hosted on Orchestrator.

• For browser-based automations on MacOS, install and manually enable the Google Chrome Extension after first Assistant launch. Restart the browser post-installation.

• When designing an automation for MacOS in Studio, you can test it using remote debugging, which involves connecting to the specific MacOS machine.

• You can access the Assistant logs in the /Users/john.doe/Library/Application Support/UiPath/combined.logs file.

• The following Assistant features are unavailable:

  • Robot session (Picture in Picture)

  • Sending automations to desktop

  • Task Capture launcher

  • RobotJS and Safari browser compatibility

  • Diagnostic Tool

在 Linux 上安装

Installing Robots on Linux requires a Docker environment, a network connection to Orchestrator, and the client credentials of the machine template.

The Docker image tag

To install the docker image of a specific Robot LTS version, you would need to mention the tag. For version 2024.10, the tag is 24.10.95.24248-robot24.10.0. To install the latest patch available, do not mention a tag. The command to download the docker image is:

docker pull registry.uipath.com/robot/uiautomation-runtime:<tag>

Linux automations - particularities

• To create automations for Linux, ensure you have Chrome extension version 2021.10.4 or later. This allows the robot to execute background and foreground automations.

• To design a UI automation for Linux, you can select the following input methods for activities:

  • ChromiumAPI: The default input mode that lets robots interact directly with Chrome elements.

  • SimulateClick/SimulateType: Simulates user actions like clicking or typing on a webpage.

  Additionally, you can use the following tools:

  • Web Recorder: Replicates a series of actions on a webpage that a robot can replay.

  • Table Extraction: A tool to facilitate data extraction from web tables.

Parameters for the docker run command

The following table summarizes the parameters used by the docker run command. Use this command to start the Docker image.

参数	描述	示例
LICENSE_AGREEMENT=accept	Accepts the UiPath license agreement.	Using the client ID and client secret: docker run -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_"-e CLIENT_ID="$Client_ID" -e CLIENT_SECRET="$Client_secret" -tid registry.uipath.com/robot/uiautomation-runtime:<tag> Using the machine key: docker run -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -e MACHINE_KEY="$KEY" -tid registry.uipath.com/robot/uiautomation-runtime:<tag>
ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_"	Sets the URL of the Orchestrator instance where your robots should connect.
CLIENT_ID="$Client_ID" Use together with client secret. If you use the machine key, do not use this parameter.	Sets the client ID of the machine template.
CLIENT_SECRET="$Client_secret" Use together with client ID.	Sets the client secret of the machine template.
MACHINE_KEY="$KEY" If you use client ID and secret, do not use this parameter.	Sets the key of the machine template.
VNC_ENABLED=true	Optional. Enables the live streaming of the Robot execution on Linux through Virtual Networking Computing (VNC). Requires port 5000:5900 for accessing the VNC server. 重要提示： After enabling the VNC server, use any VNC client to live stream the robot execution.	docker run -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="{orchestrator url}" -e MACHINE_KEY="{machine_key}" -p 50000:5900 --env VNC_ENABLED=true registry.uipath.com/robot/uiautomation-runtime:<tag>

Orchestrator connection failure

Firewall rules might block the connection to Orchestrator. To address this, specify a DNS server in the docker run command. For example:

docker run --dns="1.1.1.1" -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -e CLIENT_ID="$Client_ID" -e CLIENT_SECRET="$Client_secret" -tid registry.uipath.com/robot/uiautomation-runtime:<tag>

The value --dns="1.1.1.1" represents the public DNS resolver from Cloudflare. You can use any DNS resolver to redirect the SignalR Hub.

Configuring package feeds

Automations on Linux require certain libraries, which are stored in the /home/robotuser/.nuget/Packages/ directory of a docker container. To configure this, you need to mount the directory containing the NuGet libraries. Add the following flag to the docker run command: -v <path to packages on the host machine>:/home/robotuser/.nuget/Packages/.

For example, using machine key:

docker run -e LICENSE_AGREEMENT=accept -e MACHINE_KEY="{machine_key}" -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -v <path to packages on the host machine>:/home/robotuser/.nuget/Packages -ti registry.uipath.com/robot/uiautomation-runtime

Important: Make sure that the robot Linux user (UID1000) has read access to the mounted path leading to the package feeds.

远程调试

To debug a running robot container, use the Remote Debugging feature.