Manually Migrate Sites to Pantheon

Learn how to manually migrate a Drupal or WordPress site to Pantheon

Discuss in our Forum Discuss in Slack

Manually migrate your site to Pantheon when any of the following apply:

 Note

If you are moving a Drupal 7 or 8 site and want to upgrade to a Drupal 9 site, use one of the following guides instead:

  • Large Drupal Site Archive: Site archive exceeds the import file size limit of 500MB.
  • Large WordPress Site: WordPress site exceeds 500MB.
  • Preserve Git History: You'd like to preserve your site's existing Git commit history.
  • WordPress Site Networks
  • Plugin install unavailable on existing WordPress site: For example, if your existing site is hosted on WordPress.com, you'll be unable to install the Pantheon Migrations plugin.
  • Local WordPress Site: If your WordPress site is only on your local machine and not yet live.
  • Debug Failed Migration: It can be helpful to migrate your code, database, and files separately if the standard migration procedure failed.

 Note for Composer-based Sites

The steps outlined below do not work for Composer-based sites. If you have need help migrating a Composer-based site (or any site, for that matter), site migrations are one of the services offered by our Professional Services team.

Before You Begin

To ensure a successful migration, complete the following tasks on the source site before you start:

Create Pantheon Site

  1. Navigate to your User Dashboard and click the Migrate Existing Site button:

    The Migrate Existing Site Button

  2. Enter your current website URL, choose your site type (Drupal 7, Drupal 9, or WordPress,), and click Continue:

    Choose the Starting State for your Migrated Site

    Note: It is possible to upload a site running locally by putting in the local url. For example, (http://localhost).

  3. Name your site and select an Organization (optional), then click Create Site:

    Name the Migrated Site and Optionally Choose an Organization

  4. Click the link to manually migrate your site then select Yes to confirm:

    Choose Manual WordPress Migration

    Choose Manual Drupal Migration

  5. Click Visit your Pantheon Site Dashboard:

    Creating Your Site on Pantheon Complete for manual migration

Now that you have a new site on Pantheon, you're ready to add the major components from your existing site: custom code, files, and the database.

Import Your Code

Your code is all custom and contributed modules or plugins, themes, and libraries. The codebase should not include the wp-content/uploads (WordPress) / sites/default/files (Drupal) directory, or any other static assets you do not want tracked by version control.

 Note

If your existing site is already version controlled and you would like to preserve the commit history, import the code from the command line with Git using the instructions below. If you prefer to avoid the command line entirely, we suggest importing the codebase using an SFTP Client such as Transmit or Cyberduck.

Using an SFTP Client

  1. Navigate to Code in the Dev tab of your Site Dashboard. Confirm that Development Mode is set to SFTP.

  2. Click Connect with SFTP to access the credentials for connecting to your preferred SFTP client.

  3. Click Open SFTP Client to open your default local SFTP client, and enter your User Dashboard password when prompted.

    If you run into issues, please refer to Pantheon's SFTP documentation.

  4. Do not overwrite WordPress or Drupal core files on your Pantheon site. Upload your existing site's themes as well as plugins or modules to their locations within the root directory (code or wp-content, as shown below).

    Copy the following directories from your existing site to a matching directory in your new site's code/wp-content directory:

    • mu-plugins

    • plugins

    • themes

      As well as any other folders under wp-content that are not wp-content/uploads.

    Copy all files and folders inside the code/sites directory, except code/sites/default/files, from your existing site to a matching directory in your new site's code/sites:

     Note

    You must prepare the directory and the database if you are using Multisite and want to migrate a sub-site.

    1. Copy the base site to a new directory.

    2. Delete all sites, with the exception of:

      • sites/{sitename}: the site you are migrating
      • sites/all: contains all of your site's modules and themes
    3. Rename sites/{sitename} to sites/default.

  5. Return to the Site Dashboard on Pantheon, and you should see quite a few files ready to be committed to version control. Write a commit message such as "Import existing codebase" then click Commit.

From the Command Line with Git

  1. Navigate to your existing site's code directory in a local terminal. If your existing code is not already version controlled with Git, create a repository and add an initial commit:

    git init
    git add .
    git commit -m "initial commit"
  2. From the Dev environment of the Site Dashboard, set the site's Development Mode to Git:

    Git connection mode

  3. Copy the SSH URL for the site repository. Do not copy git clone or the site name.

    The URL should look similar to the following:

    ssh://codeserver.dev.{site-id}@codeserver.dev.{site-id}.drush.in:2222/~/repository.git
  4. Add your new Pantheon site as a remote destination for your local code repository (replace <ssh_url> with the SSH URL copied in the previous step):

    git remote add pantheon <ssh_url>
  5. Select the appropriate version of Git running on your local machine (git --version), then merge the codebase from your new Pantheon site with your existing site's codebase:

    git pull --no-rebase --squash -Xtheirs pantheon master
    git pull --no-rebase --squash -Xtheirs pantheon master --allow-unrelated-histories

    The output will resemble:

    Squash commit -- not updating HEAD
    Automatic merge went well; stopped before committing as requested

    If you haven't already configured SSH Keys, authenticate using your Pantheon Dashboard credentials when prompted for a password.

  6. Review your current index using git status, then commit all changes:

    git add .
    git commit -m "Adding Pantheon core files"
  7. Align your local branch with its remote counterpart on Pantheon:

    git pull pantheon master --no-rebase
    git pull pantheon master --no-rebase --allow-unrelated-histories
  8. Push your newly merged codebase up to your Pantheon site repository:

    git push pantheon master
  9. Go to the Code tab of your Dev environment on the Site Dashboard. You should see your site's pre-existing commit history and the most recent commit adding Pantheon's core files.

Add Your Database

The Database import requires a single .sql dump that contains the site's content and configurations.

  1. Create a .sql dump using the mysqldump utility. For example:

    mysqldump db_name > backup-file.sql
  2. Enter your username and password when prompted to authenticate the command.

    • You might want to consider using a terminus credential fetch to avoid entering credentials for future automation steps.
  3. Run the command below to load the dump file back into the server:

    mysql db_name < backup-file.sql

You can also use the Pantheon Dashboard to add your site's database.

  1. Select the Dev environment in the Site Dashboard.

  2. Select Database / Files.

  3. Click Import and add your archive accordingly (based on file size):

    If your archive is under 100MB, upload the file directly:

    1. Navigate to the MySQL database field > click File > Choose File.

    2. Select your local archive file > click Import.

      Import MySQL database from file

      Note: If you recently imported the database and need to re-import, refresh the page and use a new filename for the database file.

    If your archive is less than 500MB, import it from URL:

    1. Navigate to the MySQL database field.

    2. Click URL.

    3. Paste a publicly accessible URL for the .sql.gz file > click Import.

       Note

      Change the end of Dropbox URLs from dl=0 to dl=1 to import your archive correctly.

      Import MySQL Database from URL

    The following instructions allow you to add database archives larger than 500MBs using the command line MySQL client. You can also use a GUI client like Sequel Ace or Navicat. For more information, see Accessing MySQL Databases.

    1. Navigate to the Pantheon Site Dashboard.

    2. Open the Dev environment.

    3. Click Connection Info.

    4. Copy the Database connection string.

      The Database connection string will look similar to this:

      mysql -u pantheon -p{random-password} -h dbserver.dev.{site-id}.drush.in -P {site-port} pantheon
    5. cd into the directory containing your .sql file in your terminal.

    6. Paste the connection string and append it with: < database.sql.

      Your command will look like:

      mysql -u pantheon -p{random-password} -h dbserver.dev.{site-id}.drush.in -P {site-port} pantheon < database.sql

      If you encounter a connection-related error, the DB server could be in sleep mode. To resolve this, load the site in your browser to wake it up, and try again. For more information, see Troubleshooting MySQL Connections.

      The .sql file is imported to the Dev environment after you run the command.

Upload Your Files

Files refer to anything within sites/default/files for Drupal or wp-content/uploads for WordPress, which typically includes uploaded images, along with generated stylesheets, aggregated scripts, etc. Files are not under Git version control and are stored separately from the site's code.

You can use the Pantheon Dashboard, SFTP, or Rsync to upload your site's files.

  1. Export a tar.gz or .zip file of your files directory:

    Navigate to your WordPress site's root directory to run this command, which will create an archive file in your user's home directory:

    cd wp-content/uploads
    tar -czf ~/files.tar.gz .

    Navigate to your Drupal site's root directory to run this command, which will create an archive file in your user's home directory:

    cd sites/default/files
    tar -czf ~/files.tar.gz .
  2. From the Site Dashboard, select the Dev environment.

  3. Select Database / Files.

  4. Click Import and add your archive accordingly (based on file size):

    If your archive is under 100MB, you can upload the file directly:

    1. In the Archive of site files field, click File, then Choose File.

    2. Select your local archive file, then press Import.

    If your archive is less than 500MB, you can import it from URL:

    1. In the Archive of site files field, click URL.

    2. Paste a publicly accessible URL for the archive, and press Import. Change the end of Dropbox URLs from dl=0 to dl=1 so we can import your archive properly.

    Rsync is an excellent method for transferring a large number of files. After performing an initial rsync, subsequent jobs will only transfer the latest changes. This can help minimize the amount of time a site is in an unpredictable state (or offline) during the final step of migration, as it allows you to bring over only new content rather than re-copying every single file.

    We recommend looking into the Terminus Rsync Plugin as a helper when doing these operations, as the number of command line arguments and specifics of directory structure make it easy for human error to impact your operation.

    To sync your current directory to Pantheon:

    terminus rsync . my_site.dev:files

    When using Rsync manually, the script below is useful for dealing with transfers being interrupted due to connectivity issues. It uploads files to your Pantheon site's Dev environment. If an error occurs during transfer, it waits 180 seconds and picks up where it left off:

    migrate-rsync.sh
    #!/bin/bash
    # Site UUID is REQUIRED: Site UUID from Dashboard URL, e.g. 12345678-1234-1234-abcd-0123456789ab
    SITE_UUID=xxxxxxx
    
    ENV='dev'
    # The sshpass command is required.
    if ! [ -x "$(command -v sshpass)" ]; then
    echo 'Error: The sshpass command was not found.' >&2
    exit 1
    fi 
    
    read -sp "Your Pantheon Password: " PASSWORD
    if [[ -z "$PASSWORD" ]]; then
    echo "Whoops, need password"
    exit
    fi
    
    while [ 1 ]
    do
    sshpass -p "$PASSWORD" rsync --partial -rlvz --size-only --ipv4 --progress -e 'ssh -p 2222' ./files/* --temp-dir=../tmp/ $ENV.$SITE@appserver.$ENV.$SITE.drush.in:files/
    if [ "$?" = "0" ] ; then
    echo "rsync completed normally"
    exit
    else
    echo "Rsync failure. Backing off and retrying..."
    sleep 180
    fi
    done

You should now have all three of the major components of your site imported into Pantheon. Clear your caches on the the Pantheon Dashboard, and you are good to go! Once everything looks good, click I've Successfully Migrated Manually:

Finish Manual Migration

Troubleshooting

fatal: Not possible to fast-forward, aborting.

This error may occur when trying to merge Pantheon's codebase into your existing repository as described earlier on this page in (step 5 of importing your code from the command line:

Not possible to fast-forward, aborting.

Depending on your Git version, you may see the following error instead:

fatal: refusing to merge unrelated histories

If you see this, it is possible your local Git configuration is disallowing non-fast-forward merges:

[pull]
rebase = TRUE
ff = only

In this case, you will want to remove ff = only from your .gitconfig file and try the merge command again.

More Resources