The BaseKit cPanel plugin allows hosting companies to offer BaseKit website builder to their customers via cPanel. The plugin makes it easy to bundle BaseKit with hosting plans, and takes care of all the technical aspects of integration. This eliminates the need for development work and reduces the time to market.
How it works
The BaseKit cPanel plugin provides a simple UI to your users that will enable them to easily activate a BaseKit account and create and manage one or more websites.
The cPanel plugin talks to a BaseKit environment via the API. You configure the plugin by providing the API URL and credentials of the environment on which your users’ sites will be created and edited.
The BaseKit cPanel plugin does not include any billing functionality. It is intended that a BaseKit website will be bundled with a paid hosting package represented by a cPanel plan. This user may be billed via WHMCS or any other similar platform, but this sits outside of the scope of this plugin.
The cPanel plugin is designed to provision BaseKit packages that correspond to cPanel plans; when a user activates BaseKit, the package provisioned will mirror the cPanel plan.
- XYZ Hosting Company offers three hosting plans to their users that are represented by cPanel plans named Bronze, Silver and Gold.
- BaseKit packages named Bronze, Silver and Gold are created to mirror the cPanel plans.
- When a user activates BaseKit, the package provisioned will mirror the cPanel plan:
- If a user on the Bronze cPanel plan activates BaseKit, the cPanel plugin will provision a Bronze BaseKit package.
- If a user on the Silver cPanel plan activates BaseKit, the cPanel plugin will provision a Silver BaseKit package.
- If a user on the Gold cPanel plan activates BaseKit, the cPanel plugin will provision a Gold BaseKit package.
cPanel Account Activation
Within a users cPanel portal, opening the Basekit plugin for the first time will present the user with an Activate button.
By clicking the Activate button, a new BaseKit user account and site is provisioned. A default domain is mapped to the site with the following format:
[cPanel username]-[timestamp].[brand domain]
For example, for cPanel username
basekit and brand domain
brand-domain.com the default domain would be
If a user has already activated, they will see a list of their BaseKit sites. Next to each site there are three options:
- Log in: log in and redirect the user to the BaseKit website editor
- Manage: redirect the user to the site management page which offers several functions (see below)
- Delete: permanently delete the BaseKit site
There are two major functions that can be performed here:
Users can point any of their cPanel-managed domains to a BaseKit site with a single click. The domain’s DNS records are automatically created and the domain should be immediately ready to be used.
If the user has already published their BaseKit site then they can toggle it online and offline by clicking the button.
To install the Basekit plugin on a WHM server, download the latest version, copy it to the server, and then follow these steps:
Upgrading from previous versions
To upgrade your old plugin, download the latest version and follow the steps above.
With the cPanel plugin installed and accessible via WHM. The next step is to configure it so that it is linked to your BaseKit environment.
Setup API Credentials
Log in to WHM as the root user and go to the BaseKit Configuration page in the Plugins section. You will need to fill in all of the fields. If you don’t know what you should enter here then please contact firstname.lastname@example.org.
Upgrading to V2 or installing v2
For the WHM Remote Access Key field you will need to use your cPanel API key. If you are unsure how to create one, follow these steps: Generating cPanel API Key.
Once the Basekit plugin has been configured with valid API credentials. You can now create one-to-one mappings between existing Basekit subscription packages to cPanel plans.
Addon packages can also be mapped, a cPanel plan can have many Basekit addon packages.
New Account Plan Assignment
Creating a new account in cPanel, you can select the plan to be assigned to the new account. Once created cPanel will use the Basekit API to prevision a new account holder and site and assign it a default domain. The account holder will be assigned the subscription package and addons that have been mapped for the selected plan.
Account Plan Management
Changes to the assigned plan for an existing cPanel account, will update the account holder in Basekit. The mapped subscription package and addons for the selected package will be used.
A user account can be de-activated / downgraded from within cPanel, by completing this action, the Basekti account holders packages and addons will be removed. The brands default package will then be assigned.