This guide will help you install, configure, and manage the BaseKit plugin for WHMCs.
Prerequisites & assumptions
To use this guide, you will need:
- A copy of BaseKit’s Plugin for WHMCs (a zip archive)
- A server running WHMCs, including the correct credentials and know-how to upload files
This guide makes the following assumptions:
- The plugin file is called
BaseKitWHMCsPlugin.zip(as this guide supports multiple version of the plugin, i.e.
- Your server running WHMCs will be referenced as
- On your server, WHMCs is installed to the
We recommend you use any secure method you feel comfortable with to upload the plugin file to the WHMCs installation directory on your server. The following example command is to upload via SSH:
scp BaseKitWHMCsPlugin.zip whmcs-instance:/var/www/whmcs/BaseKitWHMCsPlugin.zip
Log into your WHMCs server, go to the WHMCs installation directory, and unzip the contents of the plugin file. The following example commands do this via SSH and the unzip command:
These commands require that you have the permissions to create files in the WHMCs installation directory, it is
recommended that you use the credentials for the correct user rather than relying on
If you are unable to execute remote commands on your WHMCs server, you can unzip the plugin file on your computer and manually upload the resulting modules directory to the WHMCs installation directory.
- Log in to the administrator area of WHMCs
- Navigate to Setup → Products/Services → Products/Services
- Create a new Group. You can call this anything, but BaseKit is a pretty good name for obvious reasons
- Create a new Product using the group you just created. Again with the naming convention
- Switch to the Module Settings tab, then select BaseKit as the Module Name
- Fill in the Connection configuration, making sure that the connection test is successful
- You must click Save before continuing
- Next, fill in the Product configuration – you will get connection errors if you do this before filling in the Connection configuration
- Please select Responsive for the Site Type, unless you are specifically using BaseKit’s legacy editor
- Save the Product configuration setting
- Click the Generate Missing Custom Fields button (if it appears)
- A useful option to select is Automatically setup the product when you manually accept a pending order, though it is not required
Client area integration
- Go to Setup → Products/Services → Products/Services → BaseKit Plugin → Module Settings → Integration Code
- Follow the instructions for manually editing WHMCs client-area templates
Before clients can use the BaseKit plugin to purchase services, you must ensure you have at least one payment gateway enabled in Setup → Payments → Payment Gateways.
If you see text on the module settings page similar to
$_LANG['pages']['configuration'] instead of actual sentences,
you need to rebuild the language cache by:
- Navigate to Setup → General Settings and select the Localisation tab
- Select a Default Country that is anything but the currently selected one, then save
The language cache has now been rebuilt. If the country you selected is not the one you want, you can switch back to the correct one immediately.
The BaseKit plugin for WHMCs only provides translations for English. You must either make sure that your default
language is set to English in Setup → General Settings → Localisation, or rename the file
/var/www/whmcs/modules/servers/BaseKit/langs directory) to the name of your desired language (for example,
Although unlikely, SELinux or the server’s firewall may be blocking ports - contact your system administrator to check this.