This is documentation for Plesk 12.5.
Go to documentation for the latest version, Plesk Obsidian.
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] source-servers
# 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.
source-servers: pfu
# [mandatory, non-modifiable] target-type
# Target servers product type.
target-type: plesk
# [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-message-count-max-difference", 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] 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
[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.
# panel-password: setup
# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443
# [optional] unix-session-dir
# A directory for temporary files on Plesk Panel for Linux target server. If
# not specified, temporary files will be put into '/tmp'
# unix-session-dir: /tmp
# [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
# IP address or host name of the target 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.
# panel-password:
# [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.
ssh-password:
# [optional] ssh-key
# SSH private key file name. You can specify it if you select SSL
# authentication type ‘key’. If not specified, "id_rsa" or "id_dsa" keys from
# the directory '~/.ssh' are used.
# ssh-key: id_dsa
# [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 /tmp.
# session-dir: /tmp
# [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, non-modifiable] target-type
# Target servers product type.
target-type: plesk
# [mandatory] source-servers
# 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.
source-servers: 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-message-count-max-difference", 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] 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
[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.
# panel-password: setup
# [optional] plesk-port
# Port of Plesk Panel UI/API
# plesk-port: 8443
# [optional] windows-session-dir
# A directory for temporary files on Plesk Panel for Windows target server. If
# not specified, temporary files will be put into 'C:\migrator'
# windows-session-dir: C:\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 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.
# panel-password:
# [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.
windows-password:
# [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:\migrator.
# session-dir: C:\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
[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 address of this database server, exactly as displayed in Plesk Panel (usually it 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.
windows-password: