cWatch Module
This is a module for Blesta that integrates with cWatch.
Install the Module
-
You can install the module via composer:
composer require blesta/cwatch
-
OR upload the source code to a /components/modules/cwatch/ directory within your Blesta installation path.
For example:
/var/www/html/blesta/components/modules/cwatch/
-
Log in to your admin Blesta account and navigate to
Settings > Modules
- Find the cWatch module, click the "Install", and enter your cWatch username and password
Blesta Compatibility
Blesta Version | Module Version |
---|---|
< v4.2.0 | N/A |
>= v4.2.0 | v2.0.0+ |
>= v4.9.0 | v2.4.0+ |
>= v5.0.0 | v2.6.0+ |
When creating a package
Multi-license Packages
-
Add quantity configurable options for each license type you wish to offer. Available products include:
BASIC_DETECTION STARTER PRO PRO_FREE PRO_FREE_60D PREMIUM PREMIUM_FREE PREMIUM_FREE_60D
-
The 'Name' of your configurable option must match the product exactly as shown here (case-sensitive).
-
The type of your configurable options should primarily be quantity
-
The licenses are only available for the following payment terms, set config option payment terms accordingly:
BASIC_DETECTION - any STARTER - 1 Month, 12 Months, 24 Month, 36 Months PRO - 1 Month, 12 Months, 24 Month, 36 Months PRO_FREE - 1 Month PRO_FREE_60D - 2 Months PREMIUM - 1 Month, 12 Months, 24 Month, 36 Months PREMIUM_FREE - 1 Month PREMIUM_FREE_60D - 2 Months
Single-license Packages
-
The licenses are only available for the following payment terms, set package payment terms accordingly:
BASIC_DETECTION - any STARTER - 1 Month, 12 Months, 24 Month, 36 Months PRO - 1 Month, 12 Months, 24 Month, 36 Months PRO_FREE - 1 Month PRO_FREE_60D - 2 Months PREMIUM - 1 Month, 12 Months, 24 Month, 36 Months PREMIUM_FREE - 1 Month PREMIUM_FREE_60D - 2 Months
Creating a Service
Multi-license Packages
- First make sure you have your multi-license package set up along with configurable options for all the licenses you want to offer.
- Start creating a service either through the order system or the admin interface, selecting your package and term.
- Enter the name/email for the user to assign these licenses to.
- Enter a quantity for each configurable option corresponding to the number of cWatch licenses of that type you want to provision in cWatch.
- After finishing creation, a customer will be created or updated in cWatch, then the given licenses will be provisioned.
Single-license Packages
- First make sure you have your single-license package set up with the license type you want to offer.
- Start creating a service either through the order system or the admin interface, selecting your package and term.
- Enter the name/email for the user to assign this license to.
- Single license packages have the ability to automatically attach a site to the license that will be created. Enter the domain for the site you want to attach to the license.
- After finishing creation, a customer will be created or updated in cWatch, then the given licenses will be provisioned and the site will be attached to it.
Adding More Licenses
Multi-license Packages
- Manage the service.
- Change the configurable options to the desired number of licenses.
- New licenses will be provisioned in cWatch until the total number of active licenses matches the configurable options.
Single-license Packages
- A new service must be created.
Removing Licenses
Multi-license Packages
- Manage the service.
- Change the configurable options to the desired number of licenses.
- Licenses without attached sites will be selected for removal arbitrarily until enough are selected to match the configurable options. An error will be given if not enough licenses are without a domain.
- These license will be deactivated in cWatch.
- All licenses on the service may also be deactivated and their sites removed by canceling the service.
Single-license Packages
- The service must be canceled, which will remove the site from the license and deactivate it.
Adding a Site to a License
- Manage the service.
- Go to the Manage Licenses tab.
- Select the Add Site option on one of the available licenses.
- Enter your domain.
- Click the Submit button.
- A request will be sent to cWatch which will begin the process of attaching the site to the license.
- The progress of this can be seen on the Manage Licenses tab under the Domain Status column.
Removing a Site
- Manage the service.
- Go to the Manage Licenses tab.
- Select and confirm the Remove Site option.
- The site will be detached from the license and available to be added to another.
Upgrading/downgrading the License for a Site
Multi-license Packages
- Manage the service.
- Change the configurable options to add a license of the type you want to upgrade the domain to.
- Manage the service.
- Go to the Manage Licenses tab.
- To downgrade first select and confirm the Deactivate License option.
- Select the Upgrade Site option on the license with the site you want to transfer.
- Select license you want to transfer to.
- Click 'Upgrade Site'.
- cWatch will attempt to move the site from one license to the other while preserving scanners and settings.
Single-license Packages
- Manage the service.
- Change service to a single-license package of the desired license type.
- cWatch will attempt to provision a license of the new type, deactivate the current license, and move the site from one license to the other while preserving scanners and settings.
- If the license type is changing from Starter to Pro or Premium, or changing from Pro to Premium, the license itself will be upgraded instead.
Adding a Malware Scanner
- Manage the service.
- Go to the Malware Control tab.
- Select the domain to add a scanner to.
- Enter FTP credentials for the domain.
- Check the credentials by clicking the Test These Credentials button.
- If the test succeeds, submit the credentials.
- cWatch will use these to automatically install a malware scanner at that domain.