Page tree
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.46

(Home >> Transfers >> Copy an Account From Another Server)

Overview

This feature allows you to copy an account from a remote server to your web server. You will need to know certain information about the remote server to use this feature. The interface is divided into three main sections. In order to transfer accounts, you will need SSH access to the remote server, and you will need to be able to obtain root privileges through either su or sudo.

Note:

If you experience problems with session timeouts, increase the number of seconds in the Number of seconds an SSH connection related to an account transfer may be inactive before timing out setting in the System section of the Tweak Settings interface. 

 

Important note about accounts that are transferred from Plesk

If you plan to transfer accounts from Plesk, you should first change any forwarded domains to physical hosting accounts. To do so, run the following command as root from the command line:

./domain --update example.com -hst_type phys -login "example" -hosting true -ip 127.0.0.1 -passwd "examplepass"

In this example:

  • example.com stands for the forwarding domain.
  • "example" stands for the new account's username.
  • 127.0.0.1 stands for the new account's IP address.
  • "examplepass" stands for the new account's password.

If you need to convert several forwarding domains into hosting accounts, we may be able to provide help. Open a ticket in our system and our migration team will contact you.

Remote Server Info

This area of the Copy Account interface (Home >> Transfers >> Copy an account from another server) is where you will specify information about the server from which the account will be transferred. To complete this process, you will need to:

  1. Specify the Remote Server Type. From the menu, select the web control panel that the remote server runs. You have these options:
    • WHM/cPanel
    • WebPanel
    • Pl*sk
    • Zer*ex's dXm'
    • En*im
    • Alab*nza
    • CIH*st/Spectr*
    • DA
    • Sp*era
  2. Specify the Remote Server Address. This value can be in the form of an IP address or a Fully Qualified Domain Name (FQDN).
    • FQDN example —  host.example.com

      Note

      In this case, the FQDN will  not require the trailing dot. You must specify FQDNs in lowercase letters.

    • IP address example — 127.0.0.1
  3. Specify the Remote SSH port you wish to use — by default, SSH runs on port 22.
  4. If you wish, click the Check SSH Connection button to test your ability to connect to the remote server.
  5. If you wish, you may select the Don't Compress Transfer box to leave the transfer uncompressed.
  6. To encrypt the information in the transfer process, check the Use SSL box.
  7. The Allow Override box allows you to use a custom script for the transfer process. The customized script must reside in var/cpanel/lib/Whostmgr/Pkgacct on the server to which the account will be copied (the local machine). You can also use a customized module instead of the Transfers.pm module. The custom transfer module must reside in var/cpanel/lib/Whostmgr/Transfers.pm on the server to which the account will be copied.

    Note

    You can develop a custom script or a custom Transfers.pm module to override the standard transfer process. You do not need to create both a custom script and a custom Transfers.pm module.

  8. If you do not wish to transfer the account's home directory, select the Skip homedir option. This allows you to skip the normal transfer protocol for the user's home directory in favor of a faster technique, such as rsync. This will speed up the transfer process.
  9. If you do not wish to transfer the account's database infomation, select the Skip account dabatases option.
  10. If you do not wish to transfer the account's bandwidth data, select the Skip bandwidth data option.

Account Info

This section allows you to specify information about which account should be copied. To complete this process, you will need to:

  1. Specify the Username to Copy. Enter the account's username for the remote server in this text box.
  2. Specify the Local Username. Enter the account's username that will be used locally.
  3. Select the Give New Account an IP Address box to assign the new account a dedicated IP address.
  4. Select the Skip Copying Reseller Privileges box to specify the privileges the account will have after the transfer has finished.
  5. Select the Change DNS on Source Server to Point to Local Server box to update your local DNS configuration with the new account's DNS information. This will cause your local DNS configuration to function as the account's root-level DNS server(s).
  6. Select whether you wish to use the Express method to transfer the account.

About Express transfer

An express transfer performs the following actions on the remote server:

  1. Updates the account's A record to point to the destination server.
  2. Whenever appropriate, changes the domain's nameserver entry to point to the destination server.
  3. Updates the email routing configuration, so mail arrives at the destination server.
  4. Adds a redirect for the Account Moved page (cgi-sys/movingpage.cgi) for the following file extensions:
    • .dynamiccontent
    • .pl
    • .plx
    • .perl
    • .cgi
    • .php
    • .php4
    • .php5
    • .php6
    • .php3
    • .shmtl
  5. Blocks SSH and FTP logins to the source server for accounts that were transferred.

Changes are handled on the source server in the /usr/local/cpanel/scripts/xferpoint directory.

Moving an SSL Certificate

If you have an SSL certificate installed on your account, you can transfer the certificate to the new server. To do so, you must specify the account that is to be assigned a dedicated IP address.

To transfer an existing SSL Certificate:

  1. Log in to WHM.
  2. Select Transfers.
  3. Select Copy an account from another server with account password.
  4. Fill in all necessary information.
  5. Check the Give new account an IP address box.
  6. Click the Copy Account button.

Without a dedicated IP address, an SSL certificate will be copied to the new server, but not installed. To complete the SSL certificate installation process, you will need to:

  1. Log in to WHM as the root user.
  2. Select Change Site's IP Address .
  3. Select the account you wish to change.
  4. Click the Change button.
  5. In the menu, select the new address.
  6. Click the Change button. This will assign your account a dedicated IP address
  7. Select SSL/TLS on the Home screen.
  8. Select Install a SSL Certificate and Setup the Domain.
  9. Specify the Domain name. The other text boxes should auto-populate with the certificate that was copied from the old server.
  10. Select Submit at the top.

Authentication

This section allows you to specify login information for the remote server. To complete this process, you must:

  1. Specify the Login method. You are able to specify the username and password for the account you wish to transfer, or log in to the remote server as the root user.
    • If you select Root, enter the root password in the Password text box.
    • If you select User, you will need to:
      1. Specify the remote account's Username in the appropriate text box.
      2. Specify the remote account's Password in the appropriate text box.
  2. Select the Authentication Method you wish to use. Here, you must specify whether you will be using a password or a public key to authenticate to the remote server.
    • If you choose Password, the password you entered under the Username text box will suffice.
      • When you select this option, you will also need to specify a Root Escalation Method. You will need root level privileges to transfer the account.
        • If you select su, you will need the root user's password.
        • If you select sudo, you will need to include the user in the remote machine's sudoers file.
    • If you choose Public Key, you will need to select the key you wish to use for authentication. You will need to be sure the appropriate key has been installed at the Manage SSH Keys interface.
      • If necessary, you will need to enter the SSH Key Password. This password should correspond to the key that you use for authentication.
      • When you select this option, you will not need to select a Root Escalation Method
  3. Select the Use FTP to Transfer box if you would like to use FTP to complete the transfer.
  4. When you have made your selections, click the Transfer Account button.

About streaming transfers

When you use WHM to copy an account from another server, the system automatically queries the source server to determine whether streaming is a viable option.

Streaming is a quicker, less resource-intensive method to transfer accounts between cPanel & WHM servers. The streaming process occurs as follows:

  1. The pkgacct utility packages and transfers the account without the /home directory.
  2. In account restoration, the destination server retrieves the /home directory from the source server.
  3. WHM copies the /home directory through a network connection directly from the source server.

To enable streaming transfers:

  • The destination server must be able to connect to the source server through port 2086 (or port 2087 if you prefer to use SSL).
  • The user who makes the transfer must be able to log in to the source server's WHM interface with root privileges.

Note

If the source server's Require SSL option in WHM's Tweak Settings feature is enabled and Use SSL option in WHM's Copy an Account from Another Server feature is disabled, then account transfer streaming will be unsupported.