Personal tools
Namespaces

Variants
Actions

Unban Center For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Multiple Products)
(→‎About Unban Center For WHMCS)
 
(106 intermediate revisions by 10 users not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Unban Center For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Unban Center For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/unban_center/features Unban Center For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/unban-center Unban Center For WHMCS]=
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br />
+
−
We are sorry for the inconveniences.</h4>
+
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in cPanel directly from your WHMCS client area.
+
|style="padding: 10px 0px 10px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in such submodules as cPanel, DirectAdmin and Plesk, directly from your WHMCS.<br/>
−
Additionally, module lets you create your own submodules in order to integrate them with other systems and control panels.  
+
As an appealing alternative, the module will let you create your own submodules so as to integrate them with other systems and control panels.<br/>
 +
You will be also able to manage blacklists with IP addresses and IP ranges that cannot be unbanned, as well as unban your customers automatically after they log in to your client area.
 
|}
 
|}
−
*'''Features:'''
+
<!-- fixed -->
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Modularity - Each Feature Is Based On Used Submodule
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Detect And Unban IP Addresses From:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Developer Friendly Creation Of Additional Submodules
+
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Detect Server Type And Unban Accordingly
+
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel Hosted On Client's VPS/Dedicated Servers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configuration Of Unban Type
+
|style="padding: 0px 0px 0px 45px;"|✔ Unban IP Addresses From Control Panels Automatically After Logging In To WHMCS Client Area
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Black List Of IP Addresses - Protection From Unban Actions
+
|style="padding: 0px 0px 0px 30px;"|✔ Check If IP Address Is Banned
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Show Reason Of Ban
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Show All Banned IP Addresses On VPS/Dedicated Servers
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Time Left Until Next Available Unban Action
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Auto Complete VPS/Dedicated Server Credentials To Unban IP Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Receive Email Notification After Unbanning IP Address Automatically
 +
|}
 +
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Enable/Disable Unban Actions For Selected Products
+
|style="padding: 10px 0px 0px 30px;"|✔ View Dashboard Summary:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Unban Functionality Per Product Group
+
|style="padding: 0px 0px 0px 45px;"|✔ Enabled Products
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Flexible Unban Delay - Protection From Abuse
+
|style="padding: 0px 0px 0px 45px;"|✔ Pending Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple IP Addresses At Once
+
|style="padding: 0px 0px 0px 45px;"|✔ Available Services
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Logs
+
|style="padding: 0px 0px 0px 45px;"|✔ Last Cron Run
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Unban Features Per Product:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Unban Availability
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Minimum Unban Delay - Protection From Abuse
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Configure Unban Location On Control Panel
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Prevent Clients From Unbanning IP Addresses Different Than Their Current One
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Automatically Unban Clients After They Log In To WHMCS Client Area
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Choose Email Template To Notify Clients About Auto Unban
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Show Ban Reason Before Unban Attempt
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Show All Banned IP Addresses On Client's Dedicated/VPS Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Debug Mode
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Global Blacklists Of Elements Not To Be Unbanned:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ IP Ranges
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Unban Single Client From Chosen Product:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Hosting Account
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Dedicated/VPS Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 00px 30px;"|✔ Check If Client IP Address Is Banned
 +
|}
 +
{|
 +
|style="padding: 0px 0px 00px 30px;"|✔ Enable Automatic Log Cleaning After Specified Time
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ View And Delete Logs
 +
|}
 +
*'''Supported Modules:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ cPanel & [https://www.modulesgarden.com/products/whmcs/cpanel-extended#features cPanel Extended For WHMCS] - CSF, cPHulk And Imunify360
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Plesk & [https://www.modulesgarden.com/products/whmcs/plesk-extended#features Plesk Extended For WHMCS] - CSF And Fail2Ban
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin & [https://www.modulesgarden.com/products/whmcs/directadmin-extended#features DirectAdmin Extended For WHMCS] - CSF And IPs Blacklist
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ InterWorx - Native Firewall
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Supports IPv4 And IPv6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires MySQL 5.7 And Later For IPv6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Plesk Functionality Requires SSH Access And Root Account
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Intuitive Creation Of Additional Submodules
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Fully Integrated With [https://lagom.rsstudio.net/extensions/whmcs-modules-integration/unban-center-by-modulesgarden Lagom WHMCS Client Theme]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 00px 30px;"|✔ Unban IP Address Of Selected Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Information About Cause Of The Ban
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
−
*'''Additionally:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended For WHMCS]
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and Later
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/unban-center#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Unban Center For WHMCS.''' <br />
+
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/unban-center Unban Center For WHMCS.]''' <br />
−
We will guide you step by step through the whole installation and configuration process.  
+
We will guide you step by step through the whole installation and configuration process. <br/><br/>
 +
'' '''Note:''' If you are still using any versions of Unban Center For WHMCS '''prior to v2.x''', [https://www.docs.modulesgarden.com/Unban_Center_1.X_For_WHMCS read about it here].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Unban Center For WHMCS.'''
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
Files in your WHMCS directory should look like on the following screen.
+
In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Unban Center for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
File is located at '' 'modules/addons/unbanCenter/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
The first one that supports PHP 5.6 up to PHP 7.3, and the second one addressed to PHP 7.4 up to PHP 8.1.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.3 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74_81.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file ''.'''<br />
+
|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/unban-center#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>''  --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area → '' 'My Products' ''.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_4.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_2.png]]
−
Log in to your WHMCS admin area. Go to the '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Unban Center' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_5.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Unban Center For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
The file is located in '' 'modules/addons/unbanCenter/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_3.png]]
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_6.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
 +
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Go to the '' 'Addons' '' → '' 'Unban Center' '' → '' 'Integration Code' '' tab and follow the instruction of integration.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_4.png]]
−
As soon as you place the integration code in a correct location, the status of integration will change from '' 'Undone' '' to '' 'Done' ''.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder is available at '' 'your_whmcs/modules/addons/unbanCenter/' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Unban Center For WHMCS!'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_4_2.png]]
−
You can access your module at '' 'Addons' '' → '' 'Unban Center' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_8.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Unban Center' '' and press the '' 'Activate' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
 +
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''9. Finally, set up the cron command line provided below and define its frequency (1 minute interval is suggested).'''
 +
php -q /yourWHMCS/modules/addons/unbanCenter/cron/cron.php queue
 +
This will allow to enable the feature that automatically unbans customers' IP addresses after they log in to the WHMCS client area.<br/>
 +
<!--
 +
If you '''stop''' the cron processes manually, please delete the entire content of the '' '/yourWHMCS/modules/addons/unbanCenter/storage/crons/' '' folder or execute the command below:
 +
rm -r /yourWHMCS/modules/addons/unbanCenter/storage/crons/*
 +
This will allow you to run the cron process again next time. Do not forget to replace '' 'yourWHMCS' '' with your WHMCS root location.
 +
-->
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''10. You have just successfully installed Unban Center For WHMCS!'''<br />
 +
You can access your module at '' 'Addons' '' → '' 'Unban Center'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_8.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external server.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external servers.'''<br />
 
Additionally, you are able to protect specific IP addresses from the unban action.
 
Additionally, you are able to protect specific IP addresses from the unban action.
 
|}
 
|}
−
==Integration Code==
+
==Unban Types==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Placing integration code is a necessity, otherwise your clients will not be able even to see '' 'Unban' '' button.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our module has been designed in such a way so as to allow you to manage banned IP addresses on several different panels of a particular type.<br/>
 +
These are:
 +
*'''cPanel''' - unban on '''CSF, cPHulk''' ''(Blacklist Management and History Reports)'' or '''Imunify360''' (you may use one or more unban types at once)
 +
*'''DirectAdmin''' - unban on '''CSF''', '''IPs blacklist''' ''(/usr/local/directadmin/data/admin/ip_blacklist)'' or '''both''' at once
 +
*'''Plesk''' - unban on  '''CSF''' or '''Fail2Ban'''<br/> '''''Important:''' On the Plesk server there must be an SSH account that works on port '''22''' and uses the same login data ('Username' and 'Password') as the one used with Plesk server configured in WHMCS.<br/> This account must have proper permissions to run this [https://docs.plesk.com/en-US/obsidian/cli-linux/using-command-line-utilities/ip_ban-ip-address-banning-fail2ban.73594/ command]:''
 +
ip_ban <command>
  
−
Integration code can be found at '' 'Unban Center' '' addon → '' 'Integration Code' '' tab.<br />
+
*You may also create your own submodules. To learn how to do that, please read carefully this [https://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Creating_3rd_Party_Submodule section].
−
As soon as you place integration code correctly, its status will be changed to '' 'Done' ''.<br />
+
 
−
Correctly placed code is shown on the following screen.
+
It is also possible to unban only the current IP address. You simply need to select such option ''(i.e. Allow User To Unban Current IP Address Only)'' <br/>while setting the configuration or create a list of IP addresses that, no matter what type you have chosen, will not be unbanned ''(Blacklist of IP addresses).''
 
|}
 
|}
 +
 +
==Dashboard==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_10.png]]
+
|style="padding: 10px 0px 15px 15px;"|In dashboard you can find the summary of currently enabled unban configuration for products, pending tasks, active services and last cron run. <br/>The tasks list allows you to follow the current auto-unbans for the clients who log in to their WHMCS client area (the option may be enabled in products configuration). <br/>These will be performed via cron.  
 
|}
 
|}
−
 
−
==Module Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|At the '' 'Module Configuration' '' tab you can easily enable and configure unban action.
+
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_10_2.png]]
 
|}
 
|}
−
===Configuration of Single Product===
+
 
 +
==Configuration of Products==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's show you how to enable unban functionality for cPanel Extended product.<br />
+
|style="padding: 10px 0px 15px 15px;"|Here we show you how you can easily enable and configure unban action for your selected products.<br/>
−
Start with marking '' 'Enabled' '' checkbox and define how often your client will be able to perform unban action on specific product.<br />
+
Let us show you how to enable unban functionality for cPanel Extended product.<br />
−
Afterwards, press '' 'Advanced Settings' ''.
+
First, go to the '' 'Products' '' section and press the '' 'Edit' '' button next to the chosen product.<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Next, select desired value from '' 'Unban Type' '' and enter IP addresses protected from unban action into '' 'Black List of IP Addresses' '' textbox.<br />
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Enable' '' and then define '' 'Minimum Delay Time' '' intervals to declare how often your client will be able to perform unban action on a specific product.<br />
−
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.<br />
+
Next, enable the desired unban type/types. For cPanel there are:
−
Confirm those settings through pressing '' 'Save Changes' '' button.
+
*CSF
 +
*cPHulk
 +
*Imunify360<br/>
 +
Additionally, you can permit your clients to '''unban their current IP address''' as well as automatically unban them after they log in - '''Auto Unban After Login''' to client area ''(cron execution is required)''.<br/>
 +
'' '''Note''' Auto unbanning feature does '''not''' work for dedicated/VPS servers type.''<br/>
 +
 
 +
Select the email template that will be used to '''notify clients when their IP address has been automatically unbanned'''.<br/> You may easily preview and edit the default, inbuilt with the module template content at '' 'Setup' → 'Email Templates','' read more [https://docs.whmcs.com/Email_Templates here].<br/>
 +
 
 +
'''''Important:''' Since version 2.4.0 of the module, the inbuilt template has been updated and new variables added: '''"unban_reason"''' and '''"unban_ip"'''. <br>Please update your email template manually to include these data in the notifications sent to clients. See [[#Tips|Tips]] section for more info.''<br/>  ''*This does not apply to client who install the module in version 2.4.0 or higher for the first time.''
 +
 
 +
You can also allow your clients to '''see all banned IP addresses''' from the panel on their '''VPS/Dedicated Servers.'' <br/>
 +
In case of Hosting Account, your clients may get an option to '''show the reason of ban''' before any attempt to unban the IP address.<br/>
 +
 
 +
 
 +
Finally, by marking the '' 'Debug Mode' '' you will activate the extended logs in the WHMCS [https://docs.whmcs.com/Troubleshooting_Module_Problems module log] section.<br/>
 +
Confirm those settings by pressing the '' 'Save Changes' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_12.png]]
 
|}
 
|}
  
−
===Configuration of Multiple Products===
+
==Configuration of Blacklists==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can configure multiple products from one product group at once.<br />
+
|style="padding: 10px 0px 15px 15px;"|The blacklist section allows you to create lists of IP addresses that cannot be unbanned from your panels.<br/>
−
All product groups containing at least one supported module will be displayed in our module → '' 'Module Configuration' '' tab.<br />
+
This section is divided into two tabs. The first one allows you to create a blacklist of a single IP addresses.<br/>
−
Press '' 'Advanced Settings' '' next to the desired product group to proceed.
+
To add it, press the '' 'New IP Address' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_12_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On the following screen you can see unban functionality settings for product group.<br />
+
|style="padding: 0px 0px 15px 15px;"|Next, provide IP address you want to add to the blacklist (either in '''IPv4''' or '''IPv6''' format).<br/>
−
As you may have noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended For WHMCS' ''.<br />
+
Additionally, you can provide a description for easier identification.
−
It means that products in selected product group are using both cPanel and cPanel Extended For WHMCS modules.<br />
+
−
This way you can set up unban functionality for cPanel and cPanel Extended products separately.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_12_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Product group settings apply only to disabled products or products marked as '' 'Uses Group Settings' ''.<br />
+
|style="padding: 0px 0px 15px 15px;"|The second, '' 'IP Ranges' '' tab allows you to define entire ranges of IP addresses that will be prevented from being unbanned.<br/>
−
Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.<br />
+
Press '' 'New IP Range' '' to add a new blacklisted range.
−
Products for which group settings are applied to are marked with '' 'Uses Group Settings' '' as shown on the following screen.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_12_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can force group settings for all products in that group through using '' 'Set For All' '' button.<br />
+
|style="padding: 0px 0px 15px 15px;"|Now, provide the '''start''' and '''end''' of IP addresses range (in either '''IPv4''' or '''IPv6''' format).<br />
−
'' 'Note:' '' '' 'Set For All' '' will force group settings only to enabled products.<br />
+
Additionally, you can provide a description for easier identification.
−
In order to apply group settings to all products, disable group, enable it and press '' 'Set For All' ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_2_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_12_4.png]]
 
|}
 
|}
  
 
==Unban Users==
 
==Unban Users==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Unban Users' '' tab allows you to unban your clients IP address from any of the external servers on which they own an account.<br />
+
|style="padding: 10px 0px 15px 15px;"|This section allows you to unban your client's IP address from any external server on which they own an account.<br />
−
You can unban IP address assigned to your client accounts as well as custom IP address. Press '' 'Unban' '' as shown on the following screen.<br />
+
You can unban IP address assigned to your client's account as well as any custom IP address. <br/>
−
''Note: You will be able to unban only from external servers enabled at '' 'Unban Center For WHMCS' '' → '' 'Module Configuration' ''.''
+
When ready, press '' 'Unban' '' as shown on the following screen.<br />
 +
'' '''Note:''' You are able to unban IP addresses only from external servers enabled at the 'Products' section. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Unban Client IP Address' '' to unban IP assigned to client account.
+
|style="padding: 0px 0px 15px 15px;"|Data on '' 'Username' '', '' 'Password' '' and '' IP address '' will be filled in automatically. <br/>
 +
You can optionally add a custom hostname as well as add port number and select SSL connection.<br/>
 +
'' '''Note:''' If you leave the hostname empty, the server details assigned to that product will be used instead.
 +
 
 +
Next, leave the default client's IP address to unban or provide a custom one.<br/>
 +
 
 +
'' '''Note:''' These connection details will appear only in case of dedicated/VPS products used by the client. For hosting accounts, only 'IP Address To Unban' field is available.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Alternatively, fill in IP address to unban and press '' 'Unban' '' as shown on the following screen.
+
|style="padding: 0px 0px 20px 15px;"|You may also check if the client's IP address has a banned status without unbanning it. Simply press '' 'Check Status' '' on the users list.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To unban multiple accounts at once, select checkbox near accounts to unban and press '' 'Unban All' '' as shown on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|Now, use the default client's IP address or, alternatively, provide a custom IP address to check its ban status on the control panel.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_23.png]]
 +
|}
 +
 
 +
==Settings==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Define the setting responsible for automatic removal of old log entries after the desired number of days. <br/> Enter a number between 1 and 10000 to specify the time after which the log will be deleted. If you enter "0", this option will be disabled and logs will not be cleared.<br/>
 +
 
 +
Please keep in mind that it is the WHMCS daily cron that is responsible for clearing logs, you do not have to set any other cron job.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_16_0.png]]
 +
|}
 +
 
 +
==Logs==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found in the '' 'Logs' '' section.<br />
 +
You can find here information related to user or admin who requested unban action and its date.<br/>
 +
You can also clear old and unnecessary log entries by selecting them and pressing the '' 'Delete '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_16.png]]
 
|}
 
|}
  
 
==Client Area==
 
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's proceed to the client area → '' 'Services' ''  → '' 'My Services' '' in order to try out unban action.<br />
+
|style="padding: 10px 0px 15px 15px;"|
−
Press '' 'Unban Center' '' in order to continue.
+
Let us proceed to the client area → '' 'Services' ''  → '' 'My Services' '' in order to try out the unban action.<br />
 +
Press '' 'IP Unban Center' '' on the sidebar menu to proceed to '' 'Unban Center'. ''<br/>
 +
'' '''Note 1:''' This button is visible only if you have enabled unban support in products configuration.''<br/>
 +
'' '''Note 2:''' If the option '' 'Auto Unban After Login' '' is enabled, clients' IP addresses will be automatically unbanned from all configured control panels the moment they log in to the WHMCS client area.
 +
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now, select product for which you want to perform unban IP address action and press '' 'Next Step' ''.
+
|style="padding: 0px 0px 20px 15px;"|Now, select the product for which you want to perform action of unbanning an IP address.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If your client IP address is banned on an external server, the reason of the ban will be displayed as shown on the following screen.<br />
+
|style="padding: 0px 0px 20px 15px;"|Data on '' 'Username' '', '' 'Password' '' and '' 'IP address' '' will be filled in automatically. <br/>
−
Finish through pressing '' 'Unban' '' button.
+
Optionally, you can also add a custom hostname as well as add port number and select SSL connection.<br/>
 +
'' '''Note:''' If you leave the hostname empty, the servers details assigned to that product will be used instead.
 +
 
 +
Next, leave the default client's IP address to unban or provide a custom one.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_15.png]]
 
|}
 
|}
−
==Logs==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found at '' 'Unban Center' '' → '' 'Logs' '' tab.<br />
+
|style="padding: 0px 0px 20px 15px;"|'' '''Note:''' These connection details will appear only in case of dedicated/VPS products used by the client. For hosting accounts, only 'IP Address To Unban' field is available.''
−
In addition, you can find here information related to user or admin who requested unban action and its date.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Once the action is completed, the IP address will be unbanned immediately and you will be notified about the results. <br/>
 +
'''''Note:''' In case a low delay time has been set up, you will need to wait for the next unban attempt.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_19.png]]
 +
|}
 +
<!--
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|In case you have set up a low delay time, you will need to wait for the next unban attempt.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_19_2.png]]
 +
|}
 +
-->
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|If enabled, the option will allow your clients to preview all banned IP addresses on the server.<br/>
 +
'' '''Important:''' This feature is only valid for dedicated/VPS servers.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_19_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|When you try to open this section for the first time, the '' 'Server Details '' popup may show up. Provide your control panel credentials and press '' 'Connect' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_19_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here you can see the list of all banned IP addresses on the control panel of a server. You can unban them in the same way as explained in the previous steps.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB2_19_4.png]]
 +
|}
 +
 
 +
=Tips=
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"| 1.  Provided data to connect with a server and view a list of banned IP addresses will be stored and available to use when trying to connect another time.<br/>Keep in mind that in case the connection data have changed, simply provide new data in the adequate fields and they will override the previous ones.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. The module uses an inbuilt email template to notify clients that their service has been unbanned.<br/> If you used the module in version previous than 2.4.0 you have to manually add following variables to the template ''("ModulesGarden Unban Center - Unban Notification")'':
 +
 +
*''unban_reason'' - provides the reason of banning a service
 +
*''unban_ip'' - provides the banned service IP address
 +
 
 +
If you install the module for the first time in version 2.4.0 or higher, you do not have to introduce any changes in the template as all the variables are added by default.
 
|}
 
|}
  
−
==Creating 3rd Party Submodule==
+
=Creating 3rd Party Submodule=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The main goal of Unban Center For WHMCS is allowing you to quickly and easily create additional submodules.<br />
+
|style="padding: 10px 0px 15px 15px;"|The main goal of Unban Center For WHMCS is to allow you to quickly and easily create additional submodules.<br />
 
All you need is a little knowledge of PHP programming language and documentation of integrated module API.<br />
 
All you need is a little knowledge of PHP programming language and documentation of integrated module API.<br />
−
Required information regarding the submodule itself is located inside the examplary submodule.<br />
+
Required information regarding the submodule itself is located inside the exemplary submodule.<br />
−
It can be found at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' ''.<br />
+
It can be found at '' 'yourWHMCS/modules/addons/unbanCenter/app/Modules/Sample/Sample.php'. ''<br />
−
Owing to that, you are able to make your offer much more competitive and extend it to other systems and control panels.
+
Owing that, you are able to make your offer much more competitive and extend it to other systems, control panels and servers.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB2_17.png]]
 
|}
 
|}
 
{|'  
 
{|'  
−
|style="padding: 0px 0px 30px 15px;"|Start with renaming copy of '' 'sample' '' folder to the name used by 3rd party module. <br />
+
|style="padding: 0px 0px 30px 15px;"|Start with renaming the copy of the '' 'Sample' '' folder to the name used by your 3rd party module. <br />
−
Let's say folder with module to integrate with Unban Center For WHMCS, which is located at '' 'your_whmcs/modules/servers/' '' is named '' 'dummyIntegration' ''.<br />
+
Let us say that the folder with the module you wish to integrate with Unban Center For WHMCS is located in '' 'your_whmcs/modules/servers/' '' and is named '' 'DummyIntegration'. ''<br />
−
For that case, your folder at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' '' should be named '' 'dummyIntegration' ''.<br />
+
In this case, your folder at '' 'yourWHMCS/modules/addons/unbanCenter/app/Modules/' '' should be named '' 'DummyIntegration'. ''<br />
−
File '' 'sampleUnbanSubmodule' '' located at previously renamed folder should be renamed to '' 'dummyIntegrationUnbanModule' ''.<br />
+
The file '' 'Sample.php' '' located in the previously renamed folder should be renamed to '' 'DummyIntegrationUnbanModule.php'. ''<br />
−
Afterwards, edit file '' 'dummyIntegrationUnbanModule' '' and follow instruction housed inside.
+
Afterward, edit the '' 'DummyIntegrationUnbanModule.php' '' file and follow the instructions placed inside.
 
|}
 
|}
  
−
=Tips=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
 +
'''Note:''' Updating the module from any version prior to '''2.0.0''' will start the migration process to move settings  configured in the previous version to the new one.<br/>These cover: the configuration status, unban type, minimum delay time and option to unban only current IP address. Any created blacklists of IP addresses will '''not''' be migrated!<br/>
 +
You also need to set '''recursively writable permissions''' for '''storage''' directory in '' 'yourWHMCS/modules/addons/unbanCenter/' '' location.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/unban-center#open-source-version Open Source version] of your Unban Center For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. After update, some functionalities are not working properly.<br />
 +
''Cause:'' Your browser stores old JavaScript in its cache.<br />
 +
''Solution:'' Reload full page by using the appropriate key combination to [https://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache bypass your cache].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|3. If you were using any version of the module prior to 2.0.0, note that after upgrading to the latest version the template integration code is '''no''' longer needed.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|4. If you are getting '' 'Syntax error or access violation' '' errors when using an address in '''IPv6''' format, make sure that '''MySQL 5.7''' or a higher version is installed.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|5. '''Imunify360:''' In case you encounter an error while checking the IP address status: '' 'Imunify METHOD: GetBlackListBylp CODE: 403', '' open the ''templates_c'' folder and remove the ''cookies.txt'' file.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. After update some functionalities are not working properly.<br />
+
|style="padding: 0px 0px 30px 15px;"|6. In case "Auto Unban After Login" tasks are not added to the queue, make sure you have logged in to the client area manually. If masquerading as a client, the tasks will not be created.
−
''Cause:'' Your browser store old JavaScript in its cache.<br />
+
−
''Solution:'' Reload full page by using key combination to [bypass your cache http://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache].
+
 
|}
 
|}

Latest revision as of 14:07, 26 April 2024

Contents

[edit] About Unban Center For WHMCS

Unban Center For WHMCS allows your clients to easily unban IP addresses in such submodules as cPanel, DirectAdmin and Plesk, directly from your WHMCS.

As an appealing alternative, the module will let you create your own submodules so as to integrate them with other systems and control panels.
You will be also able to manage blacklists with IP addresses and IP ranges that cannot be unbanned, as well as unban your customers automatically after they log in to your client area.

  • Client Area Features:
✔ Automatically Detect And Unban IP Addresses From:
✔ Control Panel
✔ Control Panel Hosted On Client's VPS/Dedicated Servers
✔ Unban IP Addresses From Control Panels Automatically After Logging In To WHMCS Client Area
✔ Check If IP Address Is Banned
✔ Show Reason Of Ban
✔ Show All Banned IP Addresses On VPS/Dedicated Servers
✔ View Time Left Until Next Available Unban Action
✔ Auto Complete VPS/Dedicated Server Credentials To Unban IP Addresses
✔ Receive Email Notification After Unbanning IP Address Automatically
  • Admin Area Features:
✔ View Dashboard Summary:
✔ Enabled Products
✔ Pending Tasks
✔ Available Services
✔ Last Cron Run
✔ Configure Unban Features Per Product:
✔ Toggle Unban Availability
✔ Define Minimum Unban Delay - Protection From Abuse
✔ Configure Unban Location On Control Panel
✔ Prevent Clients From Unbanning IP Addresses Different Than Their Current One
✔ Automatically Unban Clients After They Log In To WHMCS Client Area
✔ Choose Email Template To Notify Clients About Auto Unban
✔ Show Ban Reason Before Unban Attempt
✔ Show All Banned IP Addresses On Client's Dedicated/VPS Server
✔ Toggle Debug Mode
✔ Define Global Blacklists Of Elements Not To Be Unbanned:
✔ IP Addresses
✔ IP Ranges
✔ Unban Single Client From Chosen Product:
✔ Hosting Account
✔ Dedicated/VPS Server
✔ Check If Client IP Address Is Banned
✔ Enable Automatic Log Cleaning After Specified Time
✔ View And Delete Logs
  • Supported Modules:
✔ cPanel & cPanel Extended For WHMCS - CSF, cPHulk And Imunify360
✔ Plesk & Plesk Extended For WHMCS - CSF And Fail2Ban
✔ DirectAdmin & DirectAdmin Extended For WHMCS - CSF And IPs Blacklist
✔ InterWorx - Native Firewall
  • General Info:
✔ Supports IPv4 And IPv6
✔ Requires MySQL 5.7 And Later For IPv6
✔ Plesk Functionality Requires SSH Access And Root Account
✔ Intuitive Creation Of Additional Submodules
✔ Fully Integrated With Lagom WHMCS Client Theme
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation

This tutorial will show you how to successfully install and configure Unban Center For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Note: If you are still using any versions of Unban Center For WHMCS prior to v2.x, read about it here.

1. Log in to our client area and download the module.
UB2 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.

PHP74 81.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.3, and the second one addressed to PHP 7.4 up to PHP 8.1.
Note: Keep in mind that PHP versions 5.6 up to 7.3 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74 81.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

UB2 2.png
4. When you install Unban Center For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/addons/unbanCenter/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

UB2 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

UB2 4.png
6. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/unbanCenter/' .

UB2 4 2.png
7. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Unban Center' and press the 'Activate' button.

UB2 5.png
8. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

UB2 6.png
9. Finally, set up the cron command line provided below and define its frequency (1 minute interval is suggested). 
php -q /yourWHMCS/modules/addons/unbanCenter/cron/cron.php queue

This will allow to enable the feature that automatically unbans customers' IP addresses after they log in to the WHMCS client area.

10. You have just successfully installed Unban Center For WHMCS!

You can access your module at 'Addons' → 'Unban Center'.

UB2 8.png

[edit] Configuration and Management

Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external servers.

Additionally, you are able to protect specific IP addresses from the unban action.

[edit] Unban Types

Our module has been designed in such a way so as to allow you to manage banned IP addresses on several different panels of a particular type.

These are:

  • cPanel - unban on CSF, cPHulk (Blacklist Management and History Reports) or Imunify360 (you may use one or more unban types at once)
  • DirectAdmin - unban on CSF, IPs blacklist (/usr/local/directadmin/data/admin/ip_blacklist) or both at once
  • Plesk - unban on CSF or Fail2Ban
    Important: On the Plesk server there must be an SSH account that works on port 22 and uses the same login data ('Username' and 'Password') as the one used with Plesk server configured in WHMCS.
    This account must have proper permissions to run this command:     
ip_ban <command>
  • You may also create your own submodules. To learn how to do that, please read carefully this section.

It is also possible to unban only the current IP address. You simply need to select such option (i.e. Allow User To Unban Current IP Address Only)
while setting the configuration or create a list of IP addresses that, no matter what type you have chosen, will not be unbanned (Blacklist of IP addresses).

[edit] Dashboard

In dashboard you can find the summary of currently enabled unban configuration for products, pending tasks, active services and last cron run.
The tasks list allows you to follow the current auto-unbans for the clients who log in to their WHMCS client area (the option may be enabled in products configuration).
These will be performed via cron.
UB2 10 2.png

[edit] Configuration of Products

Here we show you how you can easily enable and configure unban action for your selected products.

Let us show you how to enable unban functionality for cPanel Extended product.
First, go to the 'Products' section and press the 'Edit' button next to the chosen product.

UB2 11.png
Press 'Enable' and then define 'Minimum Delay Time' intervals to declare how often your client will be able to perform unban action on a specific product.

Next, enable the desired unban type/types. For cPanel there are:

  • CSF
  • cPHulk
  • Imunify360

Additionally, you can permit your clients to unban their current IP address as well as automatically unban them after they log in - Auto Unban After Login to client area (cron execution is required).
Note Auto unbanning feature does not work for dedicated/VPS servers type.

Select the email template that will be used to notify clients when their IP address has been automatically unbanned.
You may easily preview and edit the default, inbuilt with the module template content at 'Setup' → 'Email Templates', read more here.

Important: Since version 2.4.0 of the module, the inbuilt template has been updated and new variables added: "unban_reason" and "unban_ip".
Please update your email template manually to include these data in the notifications sent to clients. See Tips section for more info.
*This does not apply to client who install the module in version 2.4.0 or higher for the first time.

You can also allow your clients to see all banned IP addresses' from the panel on their VPS/Dedicated Servers.
In case of Hosting Account, your clients may get an option to show the reason of ban before any attempt to unban the IP address.


Finally, by marking the 'Debug Mode' you will activate the extended logs in the WHMCS module log section.
Confirm those settings by pressing the 'Save Changes' button.

UB2 12.png

[edit] Configuration of Blacklists

The blacklist section allows you to create lists of IP addresses that cannot be unbanned from your panels.

This section is divided into two tabs. The first one allows you to create a blacklist of a single IP addresses.
To add it, press the 'New IP Address' button.

UB2 12 1.png
Next, provide IP address you want to add to the blacklist (either in IPv4 or IPv6 format).

Additionally, you can provide a description for easier identification.

UB2 12 2.png
The second, 'IP Ranges' tab allows you to define entire ranges of IP addresses that will be prevented from being unbanned.

Press 'New IP Range' to add a new blacklisted range.

UB2 12 3.png
Now, provide the start and end of IP addresses range (in either IPv4 or IPv6 format).

Additionally, you can provide a description for easier identification.

UB2 12 4.png

[edit] Unban Users

This section allows you to unban your client's IP address from any external server on which they own an account.

You can unban IP address assigned to your client's account as well as any custom IP address.
When ready, press 'Unban' as shown on the following screen.
Note: You are able to unban IP addresses only from external servers enabled at the 'Products' section.

UB2 20.png
Data on 'Username' , 'Password' and IP address will be filled in automatically.

You can optionally add a custom hostname as well as add port number and select SSL connection.
Note: If you leave the hostname empty, the server details assigned to that product will be used instead.

Next, leave the default client's IP address to unban or provide a custom one.

Note: These connection details will appear only in case of dedicated/VPS products used by the client. For hosting accounts, only 'IP Address To Unban' field is available.

UB2 21.png
You may also check if the client's IP address has a banned status without unbanning it. Simply press 'Check Status' on the users list.
UB2 22.png
Now, use the default client's IP address or, alternatively, provide a custom IP address to check its ban status on the control panel.
UB2 23.png

[edit] Settings

Define the setting responsible for automatic removal of old log entries after the desired number of days.
Enter a number between 1 and 10000 to specify the time after which the log will be deleted. If you enter "0", this option will be disabled and logs will not be cleared.

Please keep in mind that it is the WHMCS daily cron that is responsible for clearing logs, you do not have to set any other cron job.

UB2 16 0.png

[edit] Logs

All unban requests and their results can be found in the 'Logs' section.

You can find here information related to user or admin who requested unban action and its date.
You can also clear old and unnecessary log entries by selecting them and pressing the 'Delete button.

UB2 16.png

[edit] Client Area

Let us proceed to the client area → 'Services' → 'My Services' in order to try out the unban action.
Press 'IP Unban Center' on the sidebar menu to proceed to 'Unban Center'.
Note 1: This button is visible only if you have enabled unban support in products configuration.
Note 2: If the option 'Auto Unban After Login' is enabled, clients' IP addresses will be automatically unbanned from all configured control panels the moment they log in to the WHMCS client area.

UB2 13.png
Now, select the product for which you want to perform action of unbanning an IP address.
UB2 14.png
Data on 'Username' , 'Password' and 'IP address' will be filled in automatically.

Optionally, you can also add a custom hostname as well as add port number and select SSL connection.
Note: If you leave the hostname empty, the servers details assigned to that product will be used instead.

Next, leave the default client's IP address to unban or provide a custom one.

UB2 15.png
Note: These connection details will appear only in case of dedicated/VPS products used by the client. For hosting accounts, only 'IP Address To Unban' field is available.
UB2 18.png
Once the action is completed, the IP address will be unbanned immediately and you will be notified about the results.

Note: In case a low delay time has been set up, you will need to wait for the next unban attempt.

UB2 19.png
If enabled, the option will allow your clients to preview all banned IP addresses on the server.

Important: This feature is only valid for dedicated/VPS servers.

UB2 19 3.png
When you try to open this section for the first time, the 'Server Details popup may show up. Provide your control panel credentials and press 'Connect' .
UB2 19 6.png
Here you can see the list of all banned IP addresses on the control panel of a server. You can unban them in the same way as explained in the previous steps.
UB2 19 4.png

[edit] Tips

1. Provided data to connect with a server and view a list of banned IP addresses will be stored and available to use when trying to connect another time.
Keep in mind that in case the connection data have changed, simply provide new data in the adequate fields and they will override the previous ones.
2. The module uses an inbuilt email template to notify clients that their service has been unbanned.
If you used the module in version previous than 2.4.0 you have to manually add following variables to the template ("ModulesGarden Unban Center - Unban Notification"):
  • unban_reason - provides the reason of banning a service
  • unban_ip - provides the banned service IP address

If you install the module for the first time in version 2.4.0 or higher, you do not have to introduce any changes in the template as all the variables are added by default.

[edit] Creating 3rd Party Submodule

The main goal of Unban Center For WHMCS is to allow you to quickly and easily create additional submodules.

All you need is a little knowledge of PHP programming language and documentation of integrated module API.
Required information regarding the submodule itself is located inside the exemplary submodule.
It can be found at 'yourWHMCS/modules/addons/unbanCenter/app/Modules/Sample/Sample.php'.
Owing that, you are able to make your offer much more competitive and extend it to other systems, control panels and servers.

UB2 17.png
Start with renaming the copy of the 'Sample' folder to the name used by your 3rd party module.

Let us say that the folder with the module you wish to integrate with Unban Center For WHMCS is located in 'your_whmcs/modules/servers/' and is named 'DummyIntegration'.
In this case, your folder at 'yourWHMCS/modules/addons/unbanCenter/app/Modules/' should be named 'DummyIntegration'.
The file 'Sample.php' located in the previously renamed folder should be renamed to 'DummyIntegrationUnbanModule.php'.
Afterward, edit the 'DummyIntegrationUnbanModule.php' file and follow the instructions placed inside.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Note: Updating the module from any version prior to 2.0.0 will start the migration process to move settings configured in the previous version to the new one.
These cover: the configuration status, unban type, minimum delay time and option to unban only current IP address. Any created blacklists of IP addresses will not be migrated!
You also need to set recursively writable permissions for storage directory in 'yourWHMCS/modules/addons/unbanCenter/' location.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Unban Center For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. After update, some functionalities are not working properly.

Cause: Your browser stores old JavaScript in its cache.
Solution: Reload full page by using the appropriate key combination to bypass your cache.

3. If you were using any version of the module prior to 2.0.0, note that after upgrading to the latest version the template integration code is no longer needed.
4. If you are getting 'Syntax error or access violation' errors when using an address in IPv6 format, make sure that MySQL 5.7 or a higher version is installed.
5. Imunify360: In case you encounter an error while checking the IP address status: 'Imunify METHOD: GetBlackListBylp CODE: 403', open the templates_c folder and remove the cookies.txt file.
6. In case "Auto Unban After Login" tasks are not added to the queue, make sure you have logged in to the client area manually. If masquerading as a client, the tasks will not be created.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Unban_Center_For_WHMCS&oldid=66749"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Unban Center For WHMCS