ISPConfig Migration Tool

The migration tool helps you to import data from other control panels (currently ISPConfig 2 and 3 – 3.1, Plesk 10 – 12.5 and Confixx 3) into a new ISPConfig 3 or ISPConfig 3.1 single- or multiserver installation. The tool can also be used to import the configuration and data from an ISPConfig 3 server into another ISPConfig 3 or ISPConfig 3.1 server, use cases are e.g. merging of several standalone servers into a new single or multiserver setup and also migrations where you want to move a complete ISPConfig installation from an old to a new server.

How does it work?

The migration tool reads data from the source server’s control panel database (currently ISPConfig 2 and 3, Plesk 10 – 12.5 or Confixx 3) and creates the corresponding accounts on the target ISPConfig 3 or ISPConfig 3.1 server using the ISPConfig remoting API.

During this process, it creates a bash file that can be executed on the target server to copy over all the files from the migrated accounts (web, email, databases).It also replaces all occurrences of the old website path with the new one in all website files, same with IP addresses.

All passwords and account names are kept during migration but you can reserve usernames for clients, FTP accounts etc. (e. g. if you want to merge multiple servers to one). Accounts from the source server that conflict with those names are either prefixed by a defined constant, or a suffix _1, _2 is appended.

All those actions are logged, so you can check what names have been changed.

Prerequisites

The ISPConfig 3 importer requires you to have a valid license to use it. You don’t need an extra license for the target server or further source servers. The migration script asks for the license key when you start it.

The importer requires the ioncube loader. The ioncube loader will be installed automatically in a temporary folder if it is not already present on the server, there is no manual configuration required, the php.ini of your server is not altered.

You cannot migrate from and to the same server. You need one source server and one target server. The source server is the one that has the data you want to import, the target server is the one with ISPConfig 3 or 3.1 already installed.

Currently the migrator can not import client templates (the client limits get imported), Mailman mailing lists, email catchall addresses, Postfix transports and Postfix relay users (used by Postfix transports). We are working to fill the gaps in the next releases.

You can find tutorials for setting up a new ISPConfig server here. We recommend to use Debian or Ubuntu, but CentOS works as well.

Your installed PHP version on the server needs to support MySQL, SOAP and SSL. Check that you have those PHP modules installed, otherwise, the importer might fail to work.

You need to have postfix with courier or dovecot as mail server on the SOURCE server.

The following source control panels are supported by now:

  • Plesk 10 – 12.5
  • ISPConfig 2
  • Confixx 3
  • ISPConfig 3 (e. g. for migrating a server or for merging two servers onto one)

Price: € 59.00 (excl. VAT)

Things to note

By default, the importer identifies accounts by username. That means if you already have an FTP account named “myftpuser” on your TARGET server, the importer will overwrite this one if an account with the same name exists on the SOURCE.
You can configure names to reserve during importer run. If you defined “myftpuser” as reserved, the importer will rename the newly imported account with the same name to “myftpuser_2”.

The importer can be run with an argument –server-prefix to change this behavior. All possible arguments are explained in the MIGRATE section below.

The importer creates a migrate.log where you can see all errors and warnings that occurred. You will find all renamed account names in here, too.

When the target server has to use dovecot IMAP and not courier IMAP if it is a mail server. Courier is supported as source server but not as target. All recent ISPConfig perfect server tutorials use dovecot anyway.

License

The Migration tool can be used multiple times on multiple servers. The license key may only be used by the buyer (individual person or company that bought the license key), the license key may not be shared with others. The onetime license fee includes minor updates and patches for the software. A minor update is an update that is released under a minor version number, e.g. when you bought the Migration tool 1.0, then all updates of the 1.x version series are included for free in the license fee.

Wording

SOURCE: the server with the data you want to import.
TARGET: the new server with ISPConfig 3 or 3.1 installed.

Installation and setup

Copy the importer archive to the SOURCE server and extract it to a folder of your choice. We recommend to use /root/migration as we will use this directory in this README. If you choose a different directory, please keep in mind to change the path in the commands we mention in here.

Start the migration

You should now be ready to start your migration. The importer will tell you everything you have to configure on your SOURCE or TARGET system during the migration run.

The most simple way to use the importer is:

/root/migration/migrate

There are some arguments that you can use to define the behavior of the importer, please see README file in the migration tool tar.gz file for details.

Support

If you encounter any problems while using the importer, please contact support.

Please provide the complete error messages you get and append the migrate.log to your mail.