With version 4 of the CSF Unblocker module, installation is easier than ever. You no longer have to edit templates edits. We have made it easy to install and configure the moduleThis addon module will allow you to provision and sell CD-keys/Serial number using WHMCS's native system.
Key new features
Six Template + template compatible
No template installation/modification
Remote hash update
Remote script update
Frontend multi-language support
CSF Cluster mode support
Differential & Passive Unblocking Mode2 Types of Keys (Serial vs Login/Password)
ReCaptcha Anti-Scam support
The module is fully integrated with WHMCS native ordering system. Which means all you have to do to get it running is to
Create a product under WHMCS
Assign the Module of the created product to KeysProvider
Select the price/welcome email/etc…
Done !
The deployed keys are searchable with WHMCS native search for easy management
Requirements
Make sure the remote servers have ioncube 10 loader enabledyou have the ioncube10 loader installed for your web server. If you are running ioncube loader earlier than ioncube 10 5 or earlier loader then you can either run easyapache to rebuild the ioncube extension automatically or manually update the ioncube loader files.
Basic Overview
There are two parts to the module
- WHMCS side - Where your client will log into your WHMCS installation and unblock their IP on their hosting server
- Remote Server side (Hosting Server) - This is where your clients are hosted
Installation Instructions Overview
The Module must be configured and enabled in your WHMCS.
The Provisioning Module of the hosting service needing to use this module must have the module enabled in the Enable for Modules under the Admin Configuration page
The Remote server must be setup with the remote server script Remote Server Installation (root required for installation, not required for running of the remote script). The remote server script must be reachable via http or https
To test the remote server is working correctly, click on the Connection Test under the first column on the Server Listing table.
WHMCS side Installation
There isn't any template modification needed for the module, simply upload the files in the whmcsUpload folder into your WHMCS/modules/addons directory.
| Tip | ||
|---|---|---|
| ||
| If you are using the csfunblocktech module, make sure you upload and activate the main module (csfunblock) first. Once the main module is activated, you can then proceed to activate the csfunblocktech module. Otherwise, the system will crash. |
Module Configuration
Enable the module by going to Setup → Addon Modules.
Once activated you will need to fill in the License key as well as configure other module settings under the Setup → Addons Module page.
Here are some configurable options for this module
download and modify the loader manually
Your WHMCS must be using a template that's build off of the six template engine as it utilizes the menu function.
Installation Instructions
Copy all the files into your WHMCS modules/addons directory. No template modification is needed
Language Files
The module includes English as the base language. If you wish to translate it to your enabled language in WHMCS. Make a copy of the english.php in /modules/addons/keysprovider/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php
Template Files
There are no template modification needed, if you wish to modify the Client area output, you can modify modules/servers/keysprovider/templates
Starting the module
Enable the module like you would for any other WHMCS module. WHMCS Admin → Setup → Addon Modules → Activate
Once activated you can set the options below
Modifying the email template
Upon installation of this module, a new email template will be installed onto your WHMCS. You can view and edit the template named WHMCS KeysProvider Template to your needs
Module Config Options
There are several options you can set with the mod. Here is a quick breakdown.
| Option | Explanation |
|---|---|
| License Key | The license key you obtained from us |
| API User | This is needed if you are running WHMCS version less than 7.2. Otherwise, can leave blank. |
| Mask Key | This option will mask the deployed key in the WHMCS → Services Listing. Eg. ABC-123-***. This is to prevent bot signups and obtaining the key |
| Masking Option | The length of masking |
| Enable QR Code | Enable showing of QR Code |
| QR Size | The width of the QR code size |
| Enable Recaptcha | Enabling it will hide your keys behind the re-captcha verification. Customer must verify before being able to view the keys |
| Enable Validation | Enabling this will display the Validation options in the Admin side of the Service page. It will allow staff to Reset or Pass the validation |
| CheckMobi Key | If using CheckMobi integration, you must have this key filled in. See CheckMobi Setup Instructions |
| Verify Limit | The number of times the customer is allow to verify a pin before they must contact support to get it reset |
| SMS/Phone Validation Limit | The number of times the customer can trigger the validation provider to send a pin to them before it's disabled |
| SMS/Phone Retry Interval | The amount of time the customer must wait (in seconds) before they can trigger a re-send of the validation SMS/Call |
| Enable Out of Key Email | This will send out an email to the customer when the Keys table is out. |
| Display My Keys Menu | This option will insert a new link in the Services Menu called My Cd-keys |
Language Files
The module includes English as the base language. If you wish to translate it to your enabled language in WHMCS. Make a copy of the english.php in /modules/addons/dnssuite/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php
Template Files
The template files are in the modules/addons/csfunblock/templates directory if you need to make any cosmetic changes.
WHMCS Client Area Frontend
The client end module will be shown on the Service page of the particular service.
Make sure you have enabled the server provisioning module in the Admin interface (Addons → WHMCS CSF Unblocker → Shown on Modules) to have it showing in the front end.
Firewall Portal (v4.6+)
This can be activated by enabled Central Portal, Add Central Portal to Service Menu options in the Module Configuration (WHMCS → Addons Configuration). If your theme is six compatible, then a link will automatically added to the Service menu.
If you are using a template that is not based on Six, you can add a link manually to the following URL.
index.php?m=csfunblock&action=portal| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|