sidebar hamburger menu

CloudLinux Advantage

Overview

CloudLinux Advantage for WHMCS automatically configures "Configurable options" that can be linked to the Product/Service.

When a client orders/upgrade a configurable option, a request will be sent to the server to change the CloudLinux features status.

Installation and Configuration

Installation and Update

  1. The addon sends requests to servers from a WHMCS cron task that is set to run every minute. Run the WHMCS system cron every minute; if it runs less often, requests wait for the next run. How to set up the cron.
  2. On Plesk servers, the required extension is installed and activated automatically with AccelerateWP 1.9-8 or later.
  3. Download archive https://repo.cloudlinux.com/plugins/whmcs-cl-advantage-plugin-latest.zip
wget -q https://repo.cloudlinux.com/plugins/whmcs-cl-advantage-plugin-latest.zip
  1. Unzip the archive to <whmcs_root>/modules/addons folder
unzip whmcs-cl-advantage-plugin-latest.zip -d <whmcs_root>/modules/addons
  1. If your hosting requires specific files permissions, change them accordingly in the folder: <whmcs_root>/modules/addons/cloudlinux_advantage
  2. Go to the admin panel page "WHMCS/System Settings/Addon Modules", activate "CloudLinuxAdvantage" WHMCS Addons page module table listing CloudLinuxAdvantage with green Activate button highlighted by a red arrow
  3. Configure addon:
    1. Enable debug mode if necessary. Logs are stored in the "Module Log".
    2. Allow administrator access to the addon page to view information about the status of the servers WHMCS Addon Modules page with CloudLinuxAdvantage Configure: Logs on Module Log checkbox, admin role access, red arrows to Configure and Save

Notes

When upgrading to a new version, be sure to open the "WHMCS/System Settings/Addon Modules" page to apply the module changes.

Setting prices for "Configurable options"

During addon activation, the configurable option groups "AccelerateWP" (AccelerateWP Premium and AccelerateWP CDN options) and "MyImunify" are created automatically (System settings/Configurable Options).

Notes

Don't change the name of the group, options and sub-options!

WHMCS AccelerateWP configurable option group: assigned hosting products and edit controls for Premium and CDN options

In the "AccelerateWP" group settings, you need to configure:

  • Choose for which products (cPanel/Plesk/DirectAdmin) you can additionally order the service.
    • AccelerateWP options work on cPanel, Plesk, and DirectAdmin.
  • For the "accelerate_wp_premium|AccelerateWP Premium" option, set the cost.
    • In the option price settings, there are two options, On and Off. Adjust prices as you see fit.
  • For the "accelerate_wp_cdn|AccelerateWP CDN" option, set the cost.
    • In the option price settings, there are options: Off, 50 GB, 100 GB etc. Adjust prices as you see fit. You can hide unwanted tariffs using the "Hide" checkbox.

WHMCS configurable option dialog for AccelerateWP Premium: radio type with Off/On sub-options and per-cycle USD pricing table

Product/Service setup

Set up your service to work with "Configurable options" in the "System settings/Products/Services".

  1. Choose the payment type, One time or Recurrent. WHMCS Edit Product Pricing tab: red arrow on Payment Type, Recurring selected, USD billing cycle pricing table
  2. Make sure the product is associated with the configurable option group "AccelerateWP". WHMCS Edit Product Configurable Options tab with AccelerateWP - CloudLinux selected in Assigned Option Groups
  3. Allow clients to upgrade Configurable options so they can purchase AccelerateWP for existing subscriptions. WHMCS Edit Product Upgrades tab with Allow upgrading or downgrading configurable options checkbox checked
  4. Save changes.
  5. Existing customers can upgrade their AccelerateWP Premium settings by changing the order using the "Upgrade/Downgrade options" button. WHMCS client area product details page with Upgrade/Downgrade Options link highlighted in the Actions sidebar
  6. New customers will be able to select AccelerateWP settings during order creation WHMCS checkout configure page for Shared Hosting Standard showing AccelerateWP Premium and CDN radios and order summary
  7. The administrator can manually change the setting of AccelerateWP by editing the purchased service by the customer WHMCS admin client profile Products/Services tab with AccelerateWP Premium Off or On radio options on the hosting service

CloudLinuxAdvantage addon page

Module page contains information about the state of active features

WHMCS admin Addons menu open on CloudLinuxAdvantage with yellow configurable option status box listing AccelerateWP and MyImunify

In case the configurable options were accidentally removed, you can re-install them on the CloudLinuxAdvantage settings page.

CloudLinuxAdvantage addon settings showing MISSED configurable options with INSTALL buttons for Premium, CDN, and MyImunify

The table shows the latest activation state and queue status for each client service, server, and suite. The "Message" column contains the result of the latest attempt.

Note

Deactivating the addon will delete this table with the activation states.

ColumnDescription
ServiceThe client service the request refers to, with its last and current status.
ServerThe server the request is sent to.
SuiteFor which product the status will be changed.
* Last status: previous status
* Current status: current status
* Will set status: the status that will be set. It depends on the selected configurable option and the status of the client's service.
MessageThe last message about the operation. A detailed error may be displayed.
QueueWhether a cron request is queued for this row.
ActionRetry now sends the request at once.
Delete removes the row from the table.

An example of sending requests to the server for selected options for the user. Each line is a report of sending a request to the server for each module that the user enabled or disabled. In case of an error, the response from the server is displayed in the "Message" column. Fix the problem and send the request again with the "Retry now" button.

CloudLinuxAdvantage addon page: last activation state table with Service, Server, Suite, Message, Queue, Action columns and Retry now buttons

The "PUSH" button is displayed for "MyImunify - Account Protection" for a bulk operation to enable/disable the module on services for which the "MyImunify - Account Protection" option is linked.

By default, the first sorted sub-option for the "MyImunify - Account Protection" option will be sent to all users, and if the user has previously independently changed the sub-option for "MyImunify - Account Protection" using the WHMCS interface, his choice will be saved and also added to the request.

More details: https://docs.imunify360.com/myimunify/#what-is-myimunify-for-hosting-admin

WHMCS Push info dialog confirming bulk MyImunify Account protection changes with Cancel and Send changes buttons

FAQ

How WHMCS communicates with end-server

The addon tracks the change in the order and services of the client.
For those client services that have the configurable options "AccelerateWP", a request is sent to the server to change the status of AccelerateWP products.

Requests are sent by the WHMCS cron task, which runs every minute. If the server returns an error, the request is not retried automatically: the error is shown in the "Message" column of the addon page. Fix the cause and click "Retry now". A later change to the client service also queues a new request.

Information about the servers to which requests were sent can be viewed on the addon page.

If debug mode is enabled, requests and errors are also written to the "Module Log".

The CloudLinuxAdvantage enters the "Allowed" status when the client service's status is set to "Active" and the configurable options "On" is selected. In other cases, the status will be set to "Default" and the feature will be turned off for user.

How to automatically open the "Upgrade/Downgrade Options" page?

Parameters can be used to determine the billing account of the user in order to display the proper page. The WHMCS plugin already redirects to the upgrade page; set upgrade-url to the root of your WHMCS instance.

Update AccelerateWP 0.0.1 module to CloudLinuxAdvantage 0.0.2

If you previously had version 0.0.1 of the module installed, you need to perform the following procedure:

  • Follow the process for installing the module version 0.0.2
  • The module will automatically update the database
  • After that, you can deactivate and remove the old module AccelerateWP 0.0.1 (<whmcs_root>/modules/addons/acceleratewp)
  • If you are using the extension, you need to update it to the latest version from the "accelerate-wp-1.5-1" package
https://your.whmcs.com/?m=cloudlinux_advantage&action=provisioning&username=democom&domain=demo.com&server_ip=10.51.0.10
ParameterValueDescription
mcloudlinux_advantageConstant.
actionprovisioningConstant.
usernamedemocomCustomer's account name.
domaindemo.comOptional. Customer's account primary domain. Not used to find the service.
server_ip10.51.0.10Primary IP of the server where AccelerateWP is installed.
suiteaccelerate_wp_premiumOptional. To display the settings of the specified suite only. Options: accelerate_wp_premium or accelerate_wp_cdn_pro.

Plesk extension

Note

From version AccelerateWP 1.9-8, installation and activation of the extension for Plesk starts automatically.

The extension adds the ability to execute cloudlinux-awp-admin commands, such as set-suite, through the Plesk XML API.

On AccelerateWP versions older than 1.9-8, install it manually only if you use the AccelerateWP WHMCS billing integration.

Note

Requires Plesk version 17.0 or higher
The Plesk extension is available since accelerate-wp-1.3-2 version

Installation

  1. Install
/usr/sbin/plesk bin extension -i /usr/share/cloudlinux/plesk-accelerate-wp-latest.zip
  1. Activate
/usr/sbin/plesk bin extension --enable accelerate-wp

Deinstallation

/usr/sbin/plesk bin extension -u accelerate-wp

End user workflow

How to update an existing order (service)

  1. Open the services page through the menu "Services - My services"
  2. Choose the service you need WHMCS client portal My Products and Services table with Services menu arrow pointing to Shared Hosting Standard row
  3. Select the action "Upgrade/Downgrade Options" WHMCS client product details Actions sidebar with Upgrade/Downgrade Options link highlighted by a red arrow
  4. Choose a new configuration and place an order WHMCS client Upgrade/Downgrade page table for AccelerateWP Premium and CDN showing current vs new configuration dropdowns
  5. Changes will occur automatically after 1 minute or after confirmation of the order by the service provider

How to checkout new order

  1. Select a service in the service provider's WHMCS portal
  2. A service with AccelerateWP enabled will display options to enable them WHMCS client configure order page highlighting AccelerateWP Premium and CDN radio options and order summary sidebar
  3. Changes will occur automatically after 1 minute or after confirmation of the order by the service provider
  4. After purchase, you need to manually activate the modules in the AccelerateWP panel

Changelog

  • 0.0.3

    • Added the ability to purchase MyImunify - Account protection
    • Add the ability to bulk send the statuses of custom options "MyImunify - Account protection" to the servers
  • 0.0.2

    • Module renamed from Accelerate WP to CloudLinux Advantage
    • Added the ability to purchase AccelerateWP CDN
    • Improved display of service and server names on the AccelerateWP module page
    • Added the ability to hide suites on the update options page
    • Changed "m" parameter in provisioning link (upgrade url) from accelerate_wp to cloudlinux_advantage
  • 0.0.1

    • Beta release

Requirements

  • 0.0.3

    • Imunify360 ^7.4.0
  • 0.0.2

    • WHMCS ^8.0
    • accelerate-wp-1.5-1
  • 0.0.1

    • WHMCS ^8.0
    • accelerate-wp-1.3-2
×
Need help?
I'm a multilingual AI chatbot, trained to answer all your questions!