Table of Contents

About Plesk

Plesk is a popular and widely used web hosting control panel. Learn more about Plesk on their website at https://www.plesk.com.

Supported Features

Create	Cancel	Suspend	Unsuspend	Management	Config Options

Installing Plesk

To install the Plesk module, visit [Settings] > [Company] > [Modules] > Available, and click the "Install" button for Plesk.

A message will be displayed, indicating that the module was successfully installed. Then click the "Add Server" button.

Enter the details for your Plesk server.

After filling out these options, click "Add Server" to add your Plesk server.

Server Groups

Server groups are useful for categorizing Plesk servers. When creating a Package, a specific server, or a server group may be selected for provisioning. Blesta will automatically select a Plesk server to provision with when a server group is chosen.

To add a server group, from the Plesk overview at  [Settings] > [Company] > [Modules] > Plesk, click "Add Server Group", then enter the details.

Creating Packages

Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.

Creating a Package consists of several sections:

Basic

The Basic section consists of the following options:

Module Options

The Module Options section consists of the following options, which are specific to Plesk:

Pricing

Click the "Add Additional Price" to add more pricing options. It's common for people to create 1 Month, 3 Month, 6 Month, and 1 Year price options. There are many possible combinations.

Welcome Email

The "Tags" section describes tags that may be used in the welcome email. The welcome email content is inserted into the "Service Creation" email template under [Settings] > [Company] > [Emails] > Service Creation. Only details unique to this service should be entered into the welcome email section for the package.

Sample Email

This sample email could be used in the Package Welcome Email section to help you get started. Be sure to enter content for your welcome email in both the HTML and Text sections.

Your Plesk account is now active, details below:

Domain: {service.plesk_domain}
Username: {service.plesk_username}
Password: {service.plesk_password}

To log into Plesk please visit https://{module.host_name}:8443.
Please update your name servers as soon as possible to the following:

{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}


Thank you for your business!

When creating or editing a package that uses this module, the following tags will be available:

Displaying Name Servers in the Welcome Email

The {module.name_servers} tag must be iterated over to display the name servers. Email tag usage is elaborated upon on the Customizing Emails page.

Consider an example where the module has two name servers set, named "ns1.domain.com" and "ns2.domain.com". The following can be added to the email template to output the name servers:

{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}

The welcome email will display this as:

Name server: ns1.domain.com
Name server: ns2.domain.com

Group Membership

If this is the first Package you are creating with this module, select the "Create a New Group" option, and enter a Group name. If you are adding a subsequent Package and wish for it to be part of the same group, select "Select from Available Groups", and move the group from the right to the left of the multi-select box.

When finished, click "Create Package" to create this package.

Final Steps

The only thing left to do is to add this Package Group to an order form so clients may place orders for your Plesk servers. See Creating an Order Form for more details.

Common Issues

If you are running Blesta on a Plesk server that you are provisioning accounts to you must enable Apache graceful restart in Plesk. This is necessary because after provisioning an account in Plesk, Plesk will restart Apache thereby killing the API connection. Blesta will never receive the response from Plesk that the account has been provisioned.

From https://kb.plesk.com/en/112020:

Symptoms

By default, Plesk does not use Apache graceful restart for applying new settings. As result Apache will be restarted every time you change hosting settings through the Plesk GUI. This can lead to unwanted interruptions of sites operation.

Resolution

To enable graceful restart, you should add the parameter "restart_apache_gracefully" with a "true" value to the "misc" table of the "psa" database. For that:

1. Log in to the Plesk database:

   mysql -uadmin -p`cat /etc/psa/.psa.shadow` -Dpsa

   
   

2. Apply the following SQL query:

   mysql> INSERT INTO misc VALUES ('restart_apache_gracefully', 'true');

   
   

Symptoms

When there is an issue interacting with the Plesk API, the module log under Tools > Logs > Module Log sometimes includes errors.

1018 - Unable to create hosting. IP address does not exist in client's pool.

This error usually indicates that the IP address is set as "dedicated" instead of shared. To check and update this in Plesk visit Tools and Settings > IP Addresses. Then, click on the IP address and change the type to "shared".