Edit

Share via

Use the sync app on virtual desktops

  • Article

For all supported operating systems, the OneDrive sync app supports:

  • Virtual desktops that persist between sessions.
  • Non-persistent virtual desktops that use Azure Virtual Desktop.
  • Non-persistent virtual desktops that have FSLogix Apps or FSLogix Office Container, and a Microsoft 365 subscription for all of the following operating systems:
    • Windows 10 and 11, 32-bit or 64-bit (supports VMDK/Virtual Machine Disk files)
    • Windows Server 2022 (supports VHDX/Virtual Hard Disk)
    • Windows Server 2019 (supports VHDX/Virtual Hard Disk)
    • Windows Server 2016 (supports VHDX/Virtual Hard Disk)
    • Windows Server 2012 R2 (supports VHDX/Virtual Hard Disk)

Note

It is not supported to roam the OneDrive registry hive as part of a non-persistent VDI environment. Do not roam HKEY_CURRENT_USER\Software\Microsoft\OneDrive\ in your non-persistent VDI user profiles.

Note

The minimum supported versions are: OneDrive 19.174.0902.0013 and FSLogix Apps 2.9.7653.47581.

Using the OneDrive sync app with non-persistent environments requires that you install the sync app per machine.

For Windows Server, the SMB network file sharing protocol is also required.

The OneDrive sync app is supported in a remote app scenario hosted as a Citrix Virtual App.

The OneDrive sync app with FSLogix does not support running multiple instances of the same container simultaneously.

Set up OneDrive in Citrix Virtual Apps

This article describes how to enable and use OneDrive in Citrix Virtual Apps.

Prerequisites

To enable OneDrive in Citrix Virtual Apps, you must have the following versions of Windows and Citrix Virtual Apps and Desktops (CVAD):

Windows:

  • Windows 11: KB5014019
  • Windows Server 2022: KB5014021
  • Windows 10: KB5014023
  • Windows Server 2019: KB5014022

Citrix:

  • CVAD 7 2203 LTSR/Long Tern Service Release CU1 or later.

  • VDA/Virtual Delivery Agent 2212 enables Shellbridge by default. All earlier versions require Shellbridge to be enabled manually.

  • To enable this feature, On 2203 LTSR TS VDA (2019 Server, 2022 Server, Windows 10 RDSH/Remote Desktop Session Host, or Windows 11 RDSH/Remote Desktop Service Host) add the following registry details:

    • HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\Citrix Virtual Desktop Agent
    • Name: Shellbridge
    • Type: REG_DWORD
    • Value: 1

To ensure that the feature is correctly enabled, open a command window (cmd.exe) and run start ms-settings:printers. If the feature is enabled, the printer setting window is displayed.

We recommend adding OneDrive.exe to LogoffCheckSysModules.

  • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Citrix\wfshell\TWI
  • Value Name:LogoffCheckSysModules
  • Type:REG_SZ
  • String:OneDrive.exe, Microsoft.Sharepoint.exe

Important

FSLogix must be used in conjunction with Citrix Virtual Apps for OneDrive to be supported.

How to set up OneDrive

  1. Install OneDrive Sync app per machine. See Install the sync app per-machine.

  2. Install the latest version of FSLogix. See Install FSLogix Applications.

    Note

    All non-persistent VDI environments require the latest version of FSLogix. Ensure you install the latest version. See OneDrive sync error FSLogix_unsupported_environment on VMs.

  3. Add OneDrive to HKLM\Software\Microsoft\Windows\CurrentVersion\ by using the following command:

    REG ADD HKLM\Software\Microsoft\Windows\CurrentVersion\Run /v OneDrive /t REG_SZ /d "\"C:\Program Files\Microsoft OneDrive\OneDrive.exe\" /background"

  4. Silently configure user accounts. See Silently configure user accounts.

    Note

    Silent sign-in should work if your machine is connected to Microsoft Entra ID. Make sure to turn off this setting if your computer is not Microsoft Entra joined.

See also

Learn more about VHDX/Virtual Hard Disk and VHD/Virtual Hard Disk.

For info about creating virtual hard disks, see Manage virtual hard disks.