Configuration Files for Plesk Migration

Configuration files for Plesk for Linux

This configuration file contains only the basic information necessary to perform the migration:

[GLOBAL]
source-type: plesk
source-servers: pfu
target-type: plesk

[plesk]
ip:
os: unix

[pfu]
ip:
os: unix
ssh-password:

This configuration file contains advanced settings, enabling you to fine-tune many aspects of the migration:

[GLOBAL]
# This section defines migrator's global settings.

# [mandatory, non-modifiable] source-type
# Source servers' product type.
#
# This is a template of configuration file for migration from Plesk Panel to
# Plesk Panel. For other source or target panels, browse other provided
# configuration templates and pick one that best suits your source type.
source-type: plesk

# [mandatory] sources
# A comma-separated list of the sections, that describe source Plesk Panel
# servers. In this setting you may specify one or more Plesk for Unix
# and/or Plesk for Windows servers.
#
# The order of the section names in this list is significant: Plesk server,
# which section is listed earlier, has priority in conflict resolution.
sources: pfu

# [optional] session-dir
# A directory for migration tool's temporary files.
# If not specified, temporary files will be put into './migration-session'.
# session-dir: migration-session

# [optional] zones-ttl
# The time in seconds, which migration tool sets as the SOA minimum TTL and
# refresh interval on a new DNS server.
# If not specified, default value is assumed: 120
# zones-ttl: 120

# [optional] external-dns-server
# An IPv4 address of an external DNS server that allows recursive DNS queries.
# Migration tool uses the specified address to test whether general Internet
# users can obtain the correct DNS records for the transferred domains. If
# nothing is specified, migration tool will use Google DNS server (8.8.8.8).
# If 'none' is specified, migration tool will skip this test.
# external-dns-server: 8.8.8.8

# [optional] mail-messages-delta-limit
# The post-migration mail checks compare the number of messages in the source
# and the target mailboxes. If the number of messages differs more than it is
# specified in "mail-messages-delta-limit", it is considered an error.
# If the option is not specified, default value is assumed: 10
# mail-messages-delta-limit: 10

# [optional] website-availability-check-timeout
# This is the timeout, that migrator uses, when testing web site availability
# after migration. If not specified, default value is assumed: 30
# website-availability-check-timeout: 30

# [optional] website-availability-depth
# Maximum depth of links to check when testing web site availability after migration.
# For example depth 2 means to check main page and all child pages, depth 3 means to check
# main page, child pages of main page and child pages of child pages.
# If not specified, default value is assumed: 2. Increasing the value will increase time
# to perform post-migration checks, but will improve coverage of tested web pages.
# website-availability-depth: 2

# [optional] website-availability-group-directories
# Whether to group files with the same directory and file extension when testing web site
# availability after migration. If enabled, and main page contains 2 links '/subdir/a.php' and
# '/subdir/b.php', only one of them will be checked. Still if files are in different directories
# (e.g. '/subdir1/a.php' and '/subdir2/b.php') or have different extension
# (e.g. '/subdir/a.php' and '/subdir/b.aspx'), both of them will be checked.
# If not specified, default value is false. Enabling that option will speed up checks, but
# decrease coverage of tested web pages.
# website-availability-group-directories: false

# [optional] log-message-context-length
# When logging a multiline output (API request, response), show only top N
# and last N lines. Default value is 0, which means to display full API requests.
# log-message-context-length: 10

# [optional] use-hosting-analyser
# Set this option to 'True', if you need to analyse hosting and detect optimal
# algorithm to copy content. Default value of this option is 'True'.
# use-hosting-analyser: True

# [optional] use-math-analyse
# Set this option to 'True', if you need to analyse hosting and detect optimal
# algorithm to copy content with math algorithm. Default value of this option is 'True'.
# Otherwise, the "matrix of strategies" algorithm would be used
# use-math-analyse: True

# [optional] hosting-analysis-ttl
# The time in seconds, which migration tool sets as minimum for hosting
# analysis results.
# If not specified, default value is assumed: 900
# hosting-analysis-ttl: 900

# [optional] skip-migrator-updates
# Do not check migrator repository for updates. Default value is 'False'
# skip-migrator-updates: False

# [optional] event-scripts-dir
# Directory with scripts/executables that should be launched on migration events
# Default is $VAR_DIR/events, where VAR_DIR is /usr/local/psa/var/modules/panel-migrator/ for Unix
# event-scripts-dir:

# [optional] use-separate-log
# Write migrator logs to a session directory, not to global logs directory.
# By default is true.
# use-separate-log: true

# [optional] adjust-applications
# Whether to fix configuration files of several commonly used web applications.
# The fix could include database connection changes, path fixes, and so on.
# By default this option is enabled. You could disable it if it breaks migration of some
# application, or if you need better speed of migration.
# adjust-applications: true

# [optional] courier-to-dovecot-migration
# Whether to convert mail directory files when migrating mail from Courier to Dovecot.
# If option is not enabled and mail directory files are not converted, then
# POP3 mail clients could get mail messages duplicated after migration.
# By default is enabled.
# courier-to-dovecot-migration: true

[plesk]
# This section defines target panel settings.

# [mandatory] ip
# An IPv4 address of the target Plesk Panel server.
ip:

# [mandatory] os
# Server's operating system type, 'unix' or 'windows'.
os: unix

# [optional] panel-username
# Panel administrator's login. If not specified, 'admin' is used.
# panel-username: admin

# [optional] panel-password
# Panel administrator password. If not specified, it is automatically detected.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]PANEL_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
# panel-password: setup

# [optional] panel-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# panel-password-type: plain

# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443

# [optional] session-dir
# A directory for temporary files on Plesk target server.
# Option makes sense only if you run Plesk Migrator on another server than target Plesk.
# If you run Plesk Migrator on the same server as target Plesk, all temporary files are placed
# to session directory according to [GLOBAL] section.
# If not specified, temporary files will be put into '/root/plesk_migrator'
# session-dir: /root/plesk_migrator

# [optional] skip-extensions
# Do not migrate Plesk extensions data. Default value is 'false'.
# skip-extensions: false

# [optional] migrate-server-wide-extensions-data
# Whether to migrate server-wide data of Plesk extensions. Default value is 'false'.
# migrate-server-wide-extensions-data: false

# [optional] is-local
# Whether migration tools are working on the same server as target Plesk.
# Default is true.
# is-local: true

# [optional] apache-restart-interval
# Minimum time interval, in seconds, between Apache restarts during a
# migration. If this interval is short, Apache will restart too often. This
# will cause long downtimes on Plesk target server. If this interval is long,
# existing users of Plesk target server will have to wait longer for their
# changes to be applied. To skip changing Apache restart interval set value to
# 'none'. If not specified, migration tool will skip changing the Apache
# restart interval.
# apache-restart-interval: none

[pfu]
# This section defines settings of source Plesk Panel server 'pfu1'.

# [mandatory] ip
# An IP v4 address of this source Plesk server.
ip:

# [mandatory] os
# Server's operating system type, 'unix' or 'windows'.
os: unix

# [optional] panel-username
# Panel administrator user name. If not specified, 'admin' is used.
# panel-username: admin

# [mandatory] panel-password
# Panel administrator password. If not specified, it is automatically detected.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]PANEL_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
# panel-password:

# [optional] panel-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# panel-password-type: plain

# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443

# [optional] ssh-username
# User name of the privileged system user on this Plesk server. If not specified, 'root' is used.
# ssh-username: root

# [optional] ssh-auth-type
# SSH authentication type.
# There are two authentication types supported: 'password' or 'key'. Default is 'password'.
# ssh-auth-type: password

# [optional] ssh-password
# Password of the privileged system user on this Plesk server.
# You must specify it, if you select SSH authentication type ‘password’.
# Note that the hash mark in password is treated as a regular symbol.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]SSH_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
ssh-password:

# [optional] ssh-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# ssh-password-type: plain

# [optional] ssh-key
# Path to SSH private key file. You can specify it if you select SSH
# authentication type 'key'. If not specified, "id_rsa" or "id_dsa" keys from
# the directory '~/.ssh' are used.
# ssh-key: /root/.ssh/id_rsa

# [optional] ssh-port
# Port number on which SSH service accepts incoming connections
# ssh-port: 22

# [optional] session-dir
# A directory for temporary files.
# If not specified, temporary files are put into /root/plesk_migrator.
# session-dir: /root/plesk_migrator

# [optional] copy-mail-content
# This parameter specifies what mail content should be copied from the server:
# 'full' to copy all mail content, and 'none' to skip copying.
# If not specified, all mail content is copied.
# copy-mail-content: full

# [optional] copy-web-content
# This parameter specifies what web content should be copied from the server:
# 'full' to copy all web content, and 'none' to skip copying.
# If not specified, all web content is copied.
# copy-web-content: full

# [optional] ssh-authorized-keys-file
# This parameter specifies location of SSH authorized keys file for root user.
# This file is necessary for setting up key auth when copying files with rsync: copy web content, deploy agent, etc.
# By default, if this parameter is not specified, migrator will put public keys to
# '~/.ssh/authorized_keys' and '~/.ssh/authorized_keys2' files. So, in default configuration
# this option should not be touched. If you have troubles setting up key auth during migration,
# check AuthorizedKeysFile option in your SSH server's configuration file (usually /etc/ssh/sshd_config).
# ssh-authorized-keys-file: ~/.ssh/authorized_keys

Configuration files for Plesk for Windows

This configuration file contains only the basic information necessary to perform the migration:

[GLOBAL]
source-type: plesk
source-servers: pfw
target-type: plesk

[plesk]
ip:
os: windows

[pfw]
ip:
os: windows
windows-password:

This configuration file contains advanced settings, enabling you to fine-tune many aspects of the migration:

[GLOBAL]
# This section defines migrator's global settings.

# [mandatory, non-modifiable] source-type
# Source servers' product type.
#
# This is a template of configuration file for migration from Plesk Panel to
# Plesk Panel. For other source or target panels, browse other provided
# configuration templates and pick one that best suits your source type.
source-type: plesk

# [mandatory] sources
# A comma-separated list of the sections, that describe source Plesk Panel
# servers. In this setting you may specify one or more Plesk for Unix
# and/or Plesk for Windows servers.
#
# The order of the section names in this list is significant: Plesk server,
# which section is listed earlier, has priority in conflict resolution.
sources: pfw

# [optional] external-db-servers
# Comma-separated list of the sections describing external source database servers.
# It is highly recommended to specify external database servers for remote MSSQL - otherwise there could be issues
# when copying database content.
# external-db-servers: mssql1

# [optional] session-dir
# A directory for migration tool's temporary files.
# If not specified, temporary files will be put into './migration-session'.
# session-dir: migration-session

# [optional] zones-ttl
# The time in seconds, which migration tool sets as the SOA minimum TTL and
# refresh interval on a new DNS server.
# If not specified, default value is assumed: 120
# zones-ttl: 120

# [optional] external-dns-server
# An IPv4 address of an external DNS server that allows recursive DNS queries.
# Migration tool uses the specified address to test whether general Internet
# users can obtain the correct DNS records for the transferred domains. If
# nothing is specified, migration tool will use Google DNS server (8.8.8.8).
# If 'none' is specified, migration tool will skip this test.
# external-dns-server: 8.8.8.8

# [optional] mail-messages-delta-limit
# The post-migration mail checks compare the number of messages in the source
# and the target mailboxes. If the number of messages differs more than it is
# specified in "mail-messages-delta-limit", it is considered an error.
# If the option is not specified, default value is assumed: 10
# mail-messages-delta-limit: 10

# [optional] website-availability-check-timeout
# This is the timeout, that migrator uses, when testing web site availability
# after migration. If not specified, default value is assumed: 30
# website-availability-check-timeout: 30

# [optional] website-availability-depth
# Maximum depth of links to check when testing web site availability after migration.
# For example depth 2 means to check main page and all child pages, depth 3 means to check
# main page, child pages of main page and child pages of child pages.
# If not specified, default value is assumed: 2. Increasing the value will increase time
# to perform post-migration checks, but will improve coverage of tested web pages.
# website-availability-depth: 2

# [optional] website-availability-group-directories
# Whether to group files with the same directory and file extension when testing web site
# availability after migration. If enabled, and main page contains 2 links '/subdir/a.php' and
# '/subdir/b.php', only one of them will be checked. Still if files are in different directories
# (e.g. '/subdir1/a.php' and '/subdir2/b.php') or have different extension
# (e.g. '/subdir/a.php' and '/subdir/b.aspx'), both of them will be checked.
# If not specified, default value is false. Enabling that option will speed up checks, but
# decrease coverage of tested web pages.
# website-availability-group-directories: false

# [optional] log-message-context-length
# When logging a multiline output (API request, response), show only top N
# and last N lines. Default value is 0, which means to display full API requests.
# log-message-context-length: 10

# [optional] use-hosting-analyser
# Set this option to 'True', if you need to analyse hosting and detect optimal
# algorithm to copy content. Default value of this option is 'True'.
# use-hosting-analyser: True

# [optional] use-math-analyse
# Set this option to 'True', if you need to analyse hosting and detect optimal
# algorithm to copy content with math algorithm. Default value of this option is 'True'.
# Otherwise, the "matrix of strategies" algorithm would be used
# use-math-analyse: True

# [optional] hosting-analysis-ttl
# The time in seconds, which migration tool sets as minimum for hosting
# analysis results.
# If not specified, default value is assumed: 900
# hosting-analysis-ttl: 900

# [optional] skip-migrator-updates
# Do not check migrator repository for updates. Default value is 'False'
# skip-migrator-updates: False

# [optional] copy-mssql-content
# Select way to copy MSSQL content: native MSSQL dumps, text dumps or automatic selection (default).
# Possible values: 'native', 'text', 'auto'
# Native backups require direct access of migration tool to all MSSQL servers, so make sure that you provided
# access to all external MSSQL servers in 'external-db-servers' option.
# Native backup is the most reliable way to copy MSSQL database content.
# Text dumps have an advantage that they do not require physical access to the servers. Only access by MSSQL
# protocols is required. But such way may fail in case of complex MSSQL databases with stored procedures, triggers, etc.
# If automatic selection is specified, panel migrator will use native backups if we have direct access to the servers
# with MSSQL, and text dumps otherwise.
# copy-mssql-content: auto

# [optional] use-separate-log
# Write migrator logs to a session directory, not to global logs directory.
# By default is true.
# use-separate-log: true

# [optional] adjust-applications
# Whether to fix configuration files of several commonly used web applications.
# The fix could include database connection changes, path fixes, and so on.
# By default this option is enabled. You could disable it if it breaks migration of some
# application, or if you need better speed of migration.
# adjust-applications: true

[plesk]
# This section defines target panel settings.

# [mandatory] ip
# An IPv4 address of the target Plesk Panel server.
ip:

# [mandatory] os
# Server's operating system type, 'unix' or 'windows'.
os: windows

# [optional] panel-username
# Panel administrator's login.  If not specified, 'admin' is used.
# panel-username: admin

# [optional] panel-password
# Panel administrator password. If not specified, it is automatically detected.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]PANEL_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
# panel-password: setup

# [optional] panel-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# panel-password-type: plain

# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443

# [optional] session-dir
# A directory for temporary files on Plesk target server.
# Option makes sense only if you run Plesk Migrator on another server than target Plesk.
# If you run Plesk Migrator on the same server as target Plesk, all temporary files are placed
# to session directory according to [GLOBAL] section.
# If not specified, temporary files will be put into 'C:\plesk_migrator'
# session-dir: C:\plesk_migrator

# [optional] skip-extensions
# Do not migrate Plesk extensions data. Default value is 'false'.
# skip-extensions: false

# [optional] migrate-server-wide-extensions-data
# Whether to migrate server-wide data of Plesk extensions. Default value is 'false'.
# migrate-server-wide-extensions-data: false

# [optional] remote-mssql-session-dir
# A directory for temporary files on target remote MSSQL servers which were
# not specified by 'external-db-servers' option.
# MSSQL database dumps will be put into that path.
# remote-mssql-session-dir: C:\plesk_migrator

# [optional] is-local
# Whether migration tools are working on the same server as target Plesk.
# Default is true.
# is-local: true

[pfw]
# This section is an example of settings for source Plesk Panel for Windows.

# [mandatory] ip
# An IP v4 address of this source Plesk server.
ip:

# [mandatory] os
# Server's operating system type, 'unix' or 'windows'.
os: windows

# [optional] panel-username
# Panel administrator user name.  If not specified, 'admin' is used.
# panel-username: admin

# [optional] panel-password
# Panel administrator password. If not specified, it is automatically detected.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]PANEL_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
# panel-password:

# [optional] panel-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# panel-password-type: plain

# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443

# [optional] windows-username
# User name of the privileged system user on this Plesk server. Default is 'Administrator'.
# windows-username: Administrator

# [mandatory] windows-password
# Password of the privileged system user on this Plesk server.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]WINDOWS_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
windows-password:

# [optional] windows-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# windows-password-type: plain

# [optional] session-dir
# A directory for temporary files.
# Note, that for MySQL database content to be copied, this directory should be
# exported on rsync server as "migrator".
# If not specified, temporary files are put into C:\plesk_migrator.
# session-dir: C:\plesk_migrator

# [optional] copy-mail-content
# This parameter specifies what mail content should be copied from the server:
# 'full' to copy all mail content, and 'none' to skip copying.
# If not specified, all mail content is copied.
# copy-mail-content: full

# [optional] copy-web-content
# This parameter specifies what web content should be copied from the server:
# 'full' to copy all web content, and 'none' to skip copying.
# If not specified, all web content is copied.
# copy-web-content: full

# [optional] mail-source-log-enabled
# Whether additional logging is enabled for MailMigrator.exe utility running on the source server
# Corresponding log will be put to <session-dir>/mail/<domain-name>/<mail-name>/mail-backup.log
# mail-source-log-enabled: false

# [optional] mail-target-log-enabled
# Whether additional logging is enabled for MailMigrator.exe utility running on the target server
# Corresponding logs will be put to:
#   <session-dir>/mail/<domain-name>/<mail-name>/mail-restore.log
#   <session-dir>/mail/<domain-name>/<mail-name>/mail-list-messages.log
# mail-target-log-enabled: false

# [optional] mail-source-provider
# Override mail provider (mail server type) used by MailMigrator.exe utility running on the source server.
# Examples of possible values: "mailenable", "smartermail", "imap", and so on.
# For the full list of possible values, refer to "MailMigrator.exe help" output.
# mail-source-provider:

# [optional] mail-target-provider
# Override mail provider (mail server type) used by MailMigrator.exe utility running on the target server.
# Examples of possible values: "mailenable", "smartermail", "imap", and so on.
# For the full list of possible values, refer to "MailMigrator.exe help" output.
# mail-target-provider:

# [optional] mail-source-additional-options
# Additional command line options to pass to MailMigrator.exe utility running on the source server.
# Example of value (to specify IMAP port): --port=123
# mail-source-additional-options:

# [optional] mail-target-additional-options
# Additional command line options to pass to MailMigrator.exe utility running on the target server.
# Example of value (to specify IMAP port): --port=123
# mail-target-additional-options:

[mssql1]
# This optional section defines settings of external MSSQL database server 'mssql1'.
# Fill this section's settings and list it in the 'external-db-servers'
# setting of GLOBAL section to get the MSSQL databases copied from this server with native MSSQL backup.
# Remove this section otherwise.

# [mandatory] host
# The host of this database server, exactly as displayed in Plesk Panel.
# For MSSQL it usually consists of IP address and instance name, for example:
#   192.168.1.1\MSSQLSERVER2008
# For other servers, it usually equals to database server's IP address.
host:

# [mandatory] type
# Type of the database server, the only allowed value is 'mssql'
type: mssql

# [mandatory] ip
# An IP v4 address of this database server.
ip:

# [optional] windows-username
# User name of the privileged system user on this centralized mail server. Default is 'Administrator'.
# windows-username: Administrator

# [mandatory] windows-password
# Password of the privileged system user on this database server.
# The more secure way to pass a password is using the environment variable [SECTIONNAME_]WINDOWS_PASSWORD (the section
# name is optional). For that keep this option empty and set up the environment variable before the migrator run.
windows-password:

# [optional] windows-password-type
# Possible values: 'plain', 'encrypted'. Default is 'plain'.
# windows-password-type: plain
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.