Plesk Webserver Configuration Troubleshooter

Created:

2016-11-16 12:40:51 UTC

Modified:

2017-06-05 06:15:30 UTC

1

Was this article helpful?


Have more questions?

Submit a request

Plesk Webserver Configuration Troubleshooter

Applicable to:

  • Plesk 10.4 for Linux
  • Plesk 11.0 for Linux
  • Plesk 11.5 for Linux
  • Plesk 12.0 for Linux

Contents

Changelog

1.0-3 Wed, 10 Jul 2013 21:31:12Added a check for extra configurations not owned by any object. Highlighting extra configurations as erroneous.

1.0-2 Tue, 21 May 2013 15:14:36Added facility for configuration removal and a "rebuild all" button.

1.0-1 Mon, 29 Apr 2013 13:54:16Initial release.

Problem

Web server configuration fails for websites and reconfiguring does not help. The reason for the failure is unclear and it is impossible to troubleshoot it.

Solution

To find out why the web server configuration failed, do the following:

  • On Plesk 11.x installations, use a special troubleshooting extension which, when installed, is available from the Panel.
  • On Plesk 10.4 installations, use a command-line tool as described later in this article.

These tools, prepared by Plesk engineers and the Plesk Service team, are based on their troubleshooting experience and are intendeded to assist administrators with troubleshooting.

Feel free to leave your feedback on this tool in the special thread on the Forum.

Obtaining and Installing the Extension

You can obtain and install the extension in either of the following ways:

  1. In Plesk 12, this extension is part of Plesk and can be installed from Tools & Settings > Updates & Upgrades > Add/remove components in the Additional Plesk Extensions section.

    The extension is available in the full installation, but may be missing in a minimal installation or if you performed an upgrade from an earlier version.

  2. By issuing the following command in the console:

    # wget http://autoinstall.plesk.com/extensions/packages/configs.zip
    # /usr/local/psa/bin/extension --install configs.zip
    The extension was successfully installed.
  3. Using the Panel user interface:

    a. Download the extension from http://autoinstall.plesk.com/extensions/packages/configs.zip .

    b. Log in to the Panel as the administrator.

    c. Go to Extensions > Add Extension .

    d. Select and upload the file you obtained in step 1 above.

    Extensions

Using the Extension:

Use this extension when you encounter the following errors in the Panel:

New files of configuration for Apache web server were not built due to errors in configuration templates
  1. Go to Extensions > Web Server Configurations Troubleshooter . The "Configurations" tab shows a list of all configuration files generated by Plesk and indicates their status (“ok” or “error”).

    configurations

  2. Filter out faulty configurations by clicking the Show Errors button. This will help you determine the sites for which configuration file generation failed.

    Here, you also can go to the corresponding subscription using the links in the Belongs To column.

  3. To check whether there are known issues related to the generation of web server configuration files, go to the Checker tab.

    When you go to this tab, it starts a script that detects the most frequent issues related to the regeneration of web server configuration files. For every detected issue, the script shows a link to the KB article that describes how to solve it.

    checker

  4. Visit the suggested articles in the Parallels Knowledgebase and try applying their solutions.

    If the suggested solutions do not help, try finding error messages indicating the reasons for failure.

  5. Search for error messages in the Panel and web servers logs. To do this, go to the Bootstraps tab.

    This lists all bootstrapper files, which are configuration files that contain directives for loading other bootstrappers or domain configuration files.

    On this tab, you can view the contents of the bootstrappers or search in the log files for references to them. This can be useful because, when a web server validates a configuration file, the error message points to the bootstrapper that includes the faulty configuration file (not the configuration file itself).

  6. Click the link Search in log files next to each file path. (To return to the Bootstraps tab, use your browser’s "Back" button.)

    If an error was found, try determining the cause by looking at the error message, or use an online search in the Plesk Troubleshooters service to find a Knowledgebase article about it.

    You also can search for the problem description and solution on the Parallels Forum or using your favorite search engine.

  7. If you did not find any errors, try using the Logs Search tab to search for error messages in log files.

    For example, you can search for the most common errors by typing any of these words: fail, denied, No such, error.

    Searching by these words also is performed in the Panel’s log files. For this reason, a huge number of search results may be displayed, and the results might not be related to the issues with regenerating web server configuration files. However, by performing such a search, you can reveal issues with additional malformed configuration directives for custom per-site PHP settings:

    2013-04-19T13:56:06+07:00 ERR (3): phpinimng failed: Cannot parse php.ini: (<class 'ConfigParser.ParsingError'>, File contains parsing errors: <stdin> [line 11]: 'mbstring.substitute_character ""\

    ')

    If an error was found, try determining the cause of the error by looking at the error message, or using an online search in the Plesk Troubleshooters service to find a Knowledgebase article by the error message.

    You also can search for the problem description and solution on the Parallels Forum or using your favorite search engine.

Using the Command-Line Utility to Check for Known Issues

In addition to the extension available in the user interface, there is a command-line tool called webserver_configuration_checker.php .

This performs the same operations as the "Checker" tab of the Web Server Configurations Troubleshooter, but can be downloaded and run from the console using the following commands:

    # wget https://support.plesk.com/hc/article_attachments/115004544209/webserver_configuration_checker.php
# /usr/local/psa/bin/sw-engine-pleskrun webserver_configuration_checker.php

Additional Information

The utility can detect the following known issues:

/213920725 Web server reconfiguration fails with error: "JkWorkersFile only allowed once"
/213369169 Unable to manage domains with "Forwarding" hosting type
/213414469 Parallels Plesk Panel generates empty domain-level Apache config files due to corrupted records in Parallels Plesk Panel database
/213952505 Reference between several subscriptions and APS applications has been broken
/213913785 Webserver (Apache/Nginx) configs regeneration fails because files with the same names as the Apache symlinks you are trying to create already exist
/213918825 Apache fails to regenerate its configuration files due to incorrect vhosts_bootstrap.conf files
/213927025 Database records with empty "Name" field in Configurations table cause a fatal PHP error during Apache reconfiguration
/213942785 Webserver reconfiguration fails with "Permission denied" error when SELinux is in enforced mode
/213938485 If there are more than 256 domains, Nginx fails with "Too many open files" error
/213389789 In some cases, extra webserver configuration files remaining after domain removal might cause conflicts at webserver configurations rebuild proccess

Attachments:

Have more questions? Submit a request
Please sign in to leave a comment.