Step 1: Install the SharePoint Migration Tool (SPMT)

Download and install

Download and install SPMT using one of the links listed below.

Public preview First release General Availability
Install here Install here Install here

Before you begin

Before you begin using SPMT, review the required permissions, prerequisites, and endpoints.

What Description
Permissions required Global or SharePoint Admin. To migrate at the organization-level, you must sign in as a Global or SharePoint admin in Microsoft 365.
Site Admin. To migrate at the site collection level, you must be a site admin for that site collection. Learn more: Understanding permissions when using the SharePoint Migration Tool
Prerequisites and Endpoints Review the SPMT system prerequisites and endpoints
SPMT Settings Review SPMT settings to understand how settings can impact your migration

Understanding Custom scripts

Allow or prevent Custom Script (NoScript)

In Microsoft 365, tenants can control if users can run custom script on personal sites and self-service created sites.

During migration, some web parts require this setting set to allow. Otherwise, the web part will not be migrated.

At least 24 hours before you start migration, do the following:

  1. Go to Settings in the SharePoint admin center, and sign in with an account that has admin permissions for your organization.

    Note

    If you have Office 365 operated by 21Vianet (China), sign in to the Microsoft 365 admin center, then browse to the SharePoint admin center and open the Settings page.

  2. At the bottom of the page, select classic settings page.

  3. Under Custom Script, select:

    Allow users to run custom script on personal sites
    Allow users to run customer script on self-service created sites

    Leave these settings in place for the duration of your migration.

    Note

    Changes to this setting might take up to 24 hours to take effect.

    For more info, see, Allow or prevent custom script.

Proxy connections

Proxy connections are not supported for either SharePoint or file share migrations. By default, SPMT doesn't use system proxy credentials and web requests will fail if Internet Explorer proxy is configured. Examples of errors you may see include "SharePoint login fail" or "cannot load document library". However, you can modify the SPMT app config file to follow your system proxy settings.

If you wish to leverage your system proxy settings, use one of these methods:

Update proxy

  1. Download the latest version of SPMT. Start SPMT.

  2. If SPMT doesn't connect to Microsoft 365, go to %localappdata%\Apps\SharePointMigrationTool\SPMT.

  3. Open the microsoft.sharepoint.migrationtool.advancedapp.exe.config file.

  4. Uncomment the default proxy setting shown here: Edit the config file to comment out the proxy setting

  5. Restart SPMT.


If SPMT doesn't upgrade

  1. If SPMT cannot upgrade itself, go to %localappdata%\Apps\SharePointMigrationTool\InstallerClient.

  2. Open the installclient.exe.config file.

  3. Add the following configuration at line 31, just after the <appSettings></appSettings tag:

    Edit the config file

  4. Launch installclient.exe and SPMT should auto-upgrade to latest SPMT release.

  5. Open the microsoft.sharepoint.migrationtool.advancedapp.exe.config file.

  6. Comment out the default proxy setting:

    Edit the config file to comment out the proxy setting

  7. Restart SPMT.

Step 2: Create a migration task



Note

Currently, the SharePoint Migration Tool is not available for users of Office 365 operated by 21Vianet in China.

Introducing the SharePoint Migration Tool

How the SharePoint Migration Tool works

How to format your JSON or CSV file for data content migration

Create a user mapping file for data content migration

SharePoint and OneDrive migration speed

SharePoint Migration Tool Feedback and Support Forum