Plesk pre-upgrade checker shows warning: There are custom web server configuration templates

Taras Ermoshin

Updated July 10, 2024 16:27

Plesk for Linux kb: technical

Symptoms

Plesk pre-upgrade checker shows a warning:

CONFIG_TEXT: WARNING: Directory /usr/local/psa/admin/conf/templates/custom for custom web server configuration templates was found. Custom templates might be incompatible with a new Plesk version, and this might lead to failure to generate web server configuration files. Remove the directory to get rid of this warning. Please check https://support.plesk.com/hc/articles/12377740416151 for details.

CONFIG_TEXT: [INFO] STEP 28: Checking for custom web server configuration templates...
[WARNING] There are custom web server configuration templates at /usr/local/psa/admin/conf/templates/custom. These custom templates might be incompatible with a new Plesk version, and this might lead to failure to generate web server configuration files. Please check https://support.plesk.com/hc/en-us/articles/12377740416151 for details.
[INFO] Result: WARNING

CONFIG_TEXT: Custom web server templates that may break web server reconfiguration were moved from /usr/local/psa/admin/conf/templates/custom/ to /usr/local/psa/admin/conf/templates/custom_templates_before_17.0_aBoiafPf/

Cause

There are custom web server configuration templates stored in the directory /usr/local/psa/admin/conf/templates/custom/.

Resolution

Depending on the changes that were made in custom templates, an upgrade can be performed safely or not.

It is recommended to rename the directory /usr/local/psa/admin/conf/templates/custom/ and perform the upgrade.

Note: During the upgrade to Plesk Onyx, custom templates directory is renamed automatically, however, it does not happen when upgrading to Obsidian as the directory is kept.

Connect to the server using SSH.
Review updated default templates in the directory /usr/local/psa/admin/conf/templates/default, make appropriate changes to custom templates in the renamed directory.
Rename the directory of custom templates:

# mv /usr/local/psa/admin/conf/templates/custom_templates_before_17.0_xxxxxx/ /usr/local/psa/admin/conf/templates/custom/

More information about custom templates can be found in Plesk documentation:

Additional information

To run pre-upgrade checker, download the script from http://autoinstall.plesk.com/<Plesk_version>/examiners/panel_preupgrade_checker.php where <Plesk_version> is the version of upgraded Plesk.

For example, in order to check upgrade to Plesk Onyx 17.8.11, the link would be:

# wget http://autoinstall.plesk.com/PSA_17.8.11/examiners/panel_preupgrade_checker.php

Run the script:

# php -d safe_mode=Off panel_preupgrade_checker.php