SarahK: /* Troubleshooting */

2023-09-01T17:32:58Z

‎Troubleshooting

SarahK: Created page with "== About this Module == [https://wpsquared.com/ WP Squared], a WebPros product, hosts and manages WordPress®-specific accounts while offering a specially-tailored version o..."

2023-08-28T17:29:23Z

Created page with "== About this Module == [https://wpsquared.com/ WP Squared], a WebPros product, hosts and manages WordPress®-specific accounts while offering a specially-tailored version o..."

New page

== About this Module ==

[https://wpsquared.com/ WP Squared], a WebPros product, hosts and manages WordPress®-specific accounts while offering a specially-tailored version of WHM that meets all of the needs of WordPress hosts. It is a distinct product from WP Toolkit and other WordPress-related WebPros offerings. Our '''WP Squared''' module allows you to provision and manage accounts on WP Squared servers from within WHMCS.
<div class="docs-alert-warning">
To use the '''WP Squared''' module, the server must be a WP Squared server that uses a valid '''WP Squared''' license. WP Squared servers '''must''' run CloudLinux™ 8.
</div>
{{Provisioning_Module
| changepackage = Yes
| changepw = Yes
| usageupdates = Yes
| clientarealink = Yes
| port = 2086 and 2087}}

== Adding a WP Squared Server ==

To set up a WP Squared server in WHMCS:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]'''.
# Click '''Add New Server'''.
# Select ''WP Squared'' from the menu.
# Enter the hostname or IP address.
# Enter the username and password or API token.
#* For the username and password, use your WHM account credentials.
#* You can generate an API token in WHM at '''Development >> Manage API Tokens'''.
# Click '''Test Connection'''.
# Enter the desired additional server details.
# Examine the displayed default port. If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
# Click '''Save Changes'''.
# If this is the only WP Squared server that is currently in WHMCS, click on the name and ensure that it results in an asterisk ('''*''') next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

<div class="docs-alert-warning">
If [[Two-Factor Authentication]] is enabled on your WP Squared server, you must disable it for API requests. See below.
</div>

=== Creating a WP Squared Product ===

You can create a product that provisions accounts on your WP Squared server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]'''. You can then create a product using an existing WHM package or by defining custom options.

<div class="docs-alert-warning">
WP Squared servers do '''not''' support reseller hosting.
</div>

===== Use an Existing WHM Package =====

To create a hosting product that uses an existing WHM package, use the following product configuration:

* For '''Product Type''', select ''Shared Hosting''.
* For '''WHM Package Name''', select the desired hosting plan.

===== Defining Custom Options =====

<div class="docs-alert-info">
To configure quotas on a per-account basis, you must have <tt>root</tt>-level access to the server.
</div>

To create a hosting product with a custom package, use the following product configuration:

* For '''Product Type''', select ''Shared Hosting''.
* Do '''not''' select a package for '''WHM Package Name'''.
* After clicking '''Switch to Advanced Mode''' on the right side of the page, enter the desired values for each package setting. If you do not enter a value, the quota will be unlimited.

=== WHMCS Connect ===

WHMCS Connect allows you and your administrators to quickly and easily access the control panels of all the servers configured in your WHMCS installation that support Single Sign-On, enabling you and your staff to administer and make changes without ever needing to re-authenticate.

For more information, see [[WHMCS Connect]].

== Log in to WP Squared ==

The '''Log in to WP Squared''' link in the Client Area and the '''Log in to Control Panel''' link in the [[Admin Area]] use the server hostname if it is available. If not, they use the IP address. The use of <tt>http</tt> or <tt>https</tt> login links depends on the '''Secure''' setting in the server configuration.

The link in the Admin Area uses the <tt>xfercpanel</tt> function. When the system prompts you, enter your WHM login details ('''not''' the client's details) to log in to the client's account.

== API Token Permissions ==

API tokens in WP Squared allow you to restrict the actions that an API token can perform. To do this, you must grant the following permissions in WHM at '''Development >> Manage API Tokens'''.

<table class="table table-striped">
<tr>
<td>basic-whm-functions</td>
<td>basic-system-info</td>
<td>cpanel-api</td>
</tr>
<tr>
<td>create-acct</td>
<td>create-user-session</td>
<td>suspend-acct</td>
</tr>
<tr>
<td>upgrade-account</td>
<td>kill-acct</td>
<td>passwd</td>
</tr>
<tr>
<td>acct-summary</td>
<td>list-accts</td>
<td>show-bandwidth</td>
</tr>
<tr>
<td>cpanel-integration</td>
<td>list-pkgs</td>
<td>ns-config</td>
</tr>
<tr>
<td>edit-mx</td>
<td>manage-api-tokens</td>
<td>ssl-gencrt</td>
</tr>
</table>

=== root API Tokens ===

When creating an API token for the <tt>root</tt> user, you must also include the <tt>viewglobalpackages</tt> permission.

=== Configurable Package Addons ===

When using the Configurable Package Addon, you must also enable the <tt>edit-account</tt> permission.

== Keep DNS Zone on Termination ==

When terminating a WP Squared account via the WHMCS Admin Area, you can select '''Keep DNS Zone''' in order to retain the associated DNS zone record. You may wish to use this, for example, when performing an account migration with DNS forwarding.

<div class="docs-alert-warning">
You '''cannot''' recreate a new account on the server using the same domain while the DNS zone exists. You '''must''' delete it before you can successfully provision a new account.
</div>

== Disable Two-Factor Authentication (2FA) for the API ==

For the WP Squared module to function when 2FA is enabled for your account, you must ensure that the 2FA requirement is disabled for API requests.

To do this:

# Log in to WHM as the <tt>root</tt> user.
# Go to '''Security Center > Configure Security Policies'''.
# Uncheck '''API requests'''.
# Click '''Save'''.

== Troubleshooting ==

=== Access Denied/Permission Denied ===

An Access Denied error indicates that the WP Squared server denied WHMCS access to perform the requested action (for example, creating or modifying the account).

To investigate and resolve this issue:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]'''.
# Check whether the server settings, including the username and API token, are valid.
# Check whether the API credentials for the server have the required permissions to perform the action.
# Go to the client's profile and choose the '''Products/Services''' tab.
# Check to ensure that the '''Username''' and '''Server''' values match the account records in WHM.
# Check whether the user has the required permissions to manage the WP Squared hosting account.

<div class="docs-alert-success">
Click '''Test Connection''' to confirm that the account has access.
</div>

=== Sorry, that username is reserved ===

WP Squared does not allow usernames to contain several words, including <tt>test</tt>. Change the hosting account's username and run the '''Create''' command again.

=== Login Failed ===

There are two possible causes for this error:

* The login details under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' are incorrect. Make certain that you are using either the username and API key or the username and password combination and that the login details are correct.
* The brute force protection settings are preventing WHMCS from creating, suspending, or terminating accounts via the API. Adjust these settings in WHM.

=== No user name supplied: "username" is a required argument ===

This indicates that the username under the client's '''Products/Services''' tab is empty.

Enter a username, save the changes, and then run the '''Create''' command again.

When you do this, also ensure that you have checked '''Require Domains''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]'''.

=== Action Failed Unable to auto-login. Please contact support ===

This indicates that the username under the client's '''Products/Services''' tab is empty.

Enter a username, save the changes, and then run the '''Create''' command again.

When you do this, also ensure that you have checked '''Require Domains''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services'''.

← Older revision		Revision as of 17:32, 1 September 2023
Line 181:		Line 181:

	When you do this, also ensure that you have checked '''Require Domains''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services'''.		When you do this, also ensure that you have checked '''Require Domains''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services'''.
		+
		+	=== This module requires a WP Squared server with a valid license and the 'WP Squared' server profile. ===
		+
		+	This error indicates that you are attempting to use a server that does not run WP Squared or does not have a valid WP Squared license. Make '''certain''' that your server has the correct license and uses the correct server profile.
		+
		+	To do this, you can:
		+
		+	* Check your license in the [https://store.cpanel.net/ cPanel Store] or [https://docs.cpanel.net/manage2/licenses/list-licenses/ Manage2].
		+	* Check your server profile in WHM at '''[https://docs.cpanel.net/whm/server-configuration/server-profile/ WHM >> Server Configuration >> Server Profile]'''.
		+	* [https://cpanel.net/support/ Contact cPanel Customer Support].

WP Squared - Revision history

SarahK: /* Troubleshooting */

SarahK: Created page with "== About this Module == [https://wpsquared.com/ WP Squared], a WebPros product, hosts and manages WordPress®-specific accounts while offering a specially-tailored version o..."