Redirect and move macOS Desktop and Documents folders to OneDrive

This article is for IT admins managing the OneDrive sync app for macOS.

There are two primary advantages of moving or redirecting macOS Desktop and Documents folders to Microsoft OneDrive for the users in your organization:

  • Your users can continue using the folders they're familiar with. They don't have to change their daily work habits to save files to OneDrive.

  • Saving files to OneDrive backs up your users' data in the cloud and gives them access to their files from any device.

For these reasons, we recommend moving (redirecting) Desktop and Documents folders to OneDrive with Folder Backup if you're an enterprise or large organization. See all our recommendations for configuring the sync app. Small or medium businesses may also find this useful, but keep in mind you'll need some experience configuring settings. For info about the end-user experience, see Protect your files by saving them to OneDrive.

Note

OneDrive sync for macOS runs natively on Apple silicon. This support is generally available starting with build 22.022.

Prepare to move Desktop and Documents folders on existing devices

The standalone OneDrive sync app (not from the Mac App Store) is required for Folder Backup. This app requires Full Disk Access, which can be granted and deployed by IT admins. For more information, see Configure device restriction settings in Microsoft Intune.

We recommend that you upgrade to the latest available build before you deploy.

Important

If your organization is large and your users have a lot of files in their Desktop and Documents folders, make sure you roll out the configuration slowly to minimize the network impact of uploading files. For users who have a lot of files in their folders, consider using the setting AutomaticUploadBandwidthPercentage temporarily to minimize the network impact and then disable the setting once uploads are complete.

Folders redirected to other organizations

If a user’s Desktop and Documents folders are currently redirected to OneDrive in a different organization, redirecting to your organization’s OneDrive will create new Desktop and Documents folders and the user will see an empty desktop. The user will have to manually migrate files from the other organization’s OneDrive to OneDrive in your organization. We recommend that you disable the redirect to the other organization before redirecting to your organization if possible.

About the Folder Backup settings

You can set OneDrive settings using software distribution tools such as Microsoft Intune and Jamf Pro, Munki, AutoPkg, Apple Remote Desktop, and AppleScript. You can also configure settings in a .plist file. For a full reference of available preferences and their settings, see Deploy and configure the OneDrive sync app for macOS.

For new machines, Folder Backup can be configured from the start, so all new files are uploaded to the cloud. This is great for organizations as it increases user engagement with OneDrive, and admins can easily protect files with enterprise-level security and compliance that comes built in.

The following settings control the Folder Backup feature:

  • Prompt users to move Desktop and Documents folders to OneDrive (KFMOptInWithWizard)

    Use KFMOptInWithWizard to give the users a call to action to move their Desktop and Documents macOS folders.

    Screenshot of the dialog that prompts users to back up their important folders.

    If users dismiss the prompt, a reminder notification appears in the Sync Activity Center until they move all available folders.

    Screenshot of the notification that reminds users to protect their important folders.

    Important

    We recommend deploying the prompt setting for existing devices only, and limiting the deployment to 5,000 devices a day and not exceeding 20,000 devices a week between macOS and Windows.

  • Silently move macOS Desktop and Documents folders to OneDrive (KFMSilentOptIn)

    Use KFMSilentOptIn to redirect and move folders to OneDrive without any user interaction. Move all the folders or select the desired individual folders. By default, the Desktop and Documents folders are moved. After a folder is moved, the setting won't affect the folder again, even if the selection for the folder changes.

    You can choose to display a notification to users after their folders have been redirected.

    We also recommend using this setting together with KFMOptInWithWizard. If moving the Desktop and Documents folders silently doesn't succeed, users are prompted to correct the error and continue.

    Important

    We recommend deploying the silent setting for existing devices and new devices while limiting the deployment of existing devices to 1,000 devices a day and not exceeding 4,000 devices a week between macOS and Windows.

  • Prevent users from turning off Folder Backup (KFMBlockOptOut)

    Use KFMBlockOptOut to force users to keep their Desktop and Documents folders directed to OneDrive.

    Note

    Users can direct their Desktop and Documents folders by opening OneDrive sync app preferences, clicking the Backup tab, and then clicking Manage Backup.

  • Prevent users from moving their macOS Desktop and Documents folders to OneDrive (KFMBlockOptIn)

    Use KFMBlockOptIn to prevent users from moving their Desktop and Documents folders to any OneDrive account.

For info about using the OneDrive sync settings, see Deploy and configure the OneDrive sync app for macOS.