Personal tools
Namespaces

Variants
Actions

Unban Center For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
<meta name="keywords" content="unban center for whmcs, unban center configuration, whmcs unban center management, whmcs unban center installation, whmcs unban center common problems, about whmcs unban center, whmcs unban center documentation, whmcs unban center faq, whmcs unban center help, whmcs unban center guide, whmcs unban center wiki, whmcs unban center tutorial, whmcs unban center tips, whmcs unban center wiki"></meta>
 
<meta name="keywords" content="unban center for whmcs, unban center configuration, whmcs unban center management, whmcs unban center installation, whmcs unban center common problems, about whmcs unban center, whmcs unban center documentation, whmcs unban center faq, whmcs unban center help, whmcs unban center guide, whmcs unban center wiki, whmcs unban center tutorial, whmcs unban center tips, whmcs unban center wiki"></meta>
 
<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>
−
 
−
<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 inconvenience caused.</h4>
 
−
 
 
=About [http://www.modulesgarden.com/products/whmcs/unban_center/features Unban Center For WHMCS]=
 
=About [http://www.modulesgarden.com/products/whmcs/unban_center/features Unban Center For WHMCS]=
 
{|
 
{|
 
|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 5px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in cPanel directly from your WHMCS client area.
−
Additionally, module lets you create your own submodules in order to integrate them with other systems and control panels.  
+
Additionally, the module lets you create your own submodules in order to integrate them with other systems and control panels.  
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
−
*'''Features:'''
+
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Modularity - Each Feature Is Based On Used Submodule
+
|style="padding: 10px 0px 00px 30px;"|✔ Automatically Detect And Unban IP Address 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
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configuration Of Unban Type
+
|style="padding: 0px 0px 0px 30px;"|✔ Check If IP Address Is Banned
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Black List Of IP Addresses - Protection From Unban Actions
+
|style="padding: 0px 0px 0px 30px;"|✔ Show Reason Of Ban
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ View Time Until Next Available Unban Action
 
|}
 
|}
 
*'''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;"|✔ Configure Per Product:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Unban Functionality Per Product Group
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Unban Ability
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Flexible Unban Delay - Protection From Abuse
+
|style="padding: 0px 0px 0px 45px;"|✔ Configure Unban Behavior
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple IP Addresses At Once
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Black List Of IP Addresses - Protected From Unban Action
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Logs
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Unban Delay - Protection From Abuse
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define If Customer Can Unban Other IP Address Than Their Current One
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Default Settings
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Product Group Settings - Control Panel
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Default Settings - VPS / Dedicated Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Unban Single Client From Chosen Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple Clients From Chosen Control Panel
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 00px 30px;"|✔ Unban IP Address Of Selected Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Check If Client IP Address Is Banned
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Display The Reason Of Ban
+
|style="padding: 0px 0px 10px 30px;"|✔ View And Clear Logs
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Developer Friendly Creation Of Additional Submodules
 
|}
 
|}
 
{|
 
{|
Line 58: Line 74:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 Up To V5.3.14
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports Templates Five and Six
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
 
|}
 
|}
−
 
 
=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 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.  
 
|}
 
|}
 
{|
 
{|
−
|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 your client area and download Unban Center For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
Line 108: Line 129:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Go to '' 'Addons' '' → '' 'Unban Center' '' → '' 'Integration Code' '' tab and follow the instructions of integration.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Go to '' 'Addons' '' → '' 'Unban Center' '' → '' 'Integration Code' '' tab and follow the instructions of integration to allow access from the client area.'''<br />
−
As soon as you place the integration code in a correct location, the status of integration will change from '' 'Undone' '' to '' 'Done'. ''
+
The integration codes differ depending on the WHMCS version and template you are using.<br/>
 +
Once you perform the integration properly, the status of the integration will change to  '''Done.'''<br/>
 +
<br/>
 +
If you run Unban Center on '''WHMCS V5.x''' then you will have to copy and paste the below code:
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If you run Unban Center on the latest '''WHMCS V6.x.x''' then you will have to firstly decide which template you use:<br/>
 +
*Integration code for WHMCS V6.x.x, template '''''SIX'''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
*Integration code for WHMCS V6.x.x, template '''''FIVE'''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_2.png]]
 
|}
 
|}
 
{|
 
{|
Line 121: Line 159:
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_8.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_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 15px 15px;"|'''Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external server.'''<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==
+
<!--==Integration Code==
 
{|
 
{|
−
|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: 0px 0px 15px 15px;"|Placing integration code is a necessity, otherwise your clients will not be able even to see '' 'Unban' '' button.<br />
−
 
+
 
Integration code can be found at '' 'Unban Center' '' addon → '' 'Integration Code' '' tab.<br />
 
Integration code can be found at '' 'Unban Center' '' addon → '' 'Integration Code' '' tab.<br />
 
As soon as you place integration code correctly, its status will be changed to '' 'Done' ''.<br />
 
As soon as you place integration code correctly, its status will be changed to '' 'Done' ''.<br />
Line 137: Line 173:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_10.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_10.png]]
−
|}
+
|}-->
−
 
+
==Control Panels==
−
==Module Configuration==
+
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|At the '' 'Module Configuration' '' tab you can easily enable and configure unban action.
+
|style="padding: 10px 0px 30px 15px;"|At the '' 'Control Panels' '' tab you can easily enable and configure unban action for all or for chosen servers only.
 
|}
 
|}
 
===Configuration of Single Product===
 
===Configuration of Single Product===
Line 147: Line 182:
 
|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;"|Let's show you how to enable unban functionality for cPanel Extended product.<br />
 
Start with marking '' 'Enabled' '' checkbox and define how often your client will be able to perform unban action on specific product.<br />
 
Start with marking '' 'Enabled' '' checkbox and define how often your client will be able to perform unban action on specific product.<br />
−
Afterwards, press '' 'Advanced Settings' ''.
+
Afterwards, press '' 'Advanced Settings'. ''
 
|}
 
|}
 
{|
 
{|
Line 153: Line 188:
 
|}
 
|}
 
{|
 
{|
−
|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 20px 15px;"|Next, select desired value from '' 'Unban Type', '' you can choose form:
 +
*Unban on CSF
 +
*Unban on cPHulk ''(Blacklist Management and History Reports)''
 +
*Unban on both of the above<br/>
 +
Enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' textbox.<br />
 
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.<br />
 
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.<br />
 
Confirm those settings through pressing '' 'Save Changes' '' button.
 
Confirm those settings through pressing '' 'Save Changes' '' button.
Line 160: Line 199:
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
 
|}
 
|}
−
 
 
===Configuration of Multiple Products===
 
===Configuration of Multiple Products===
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|You can configure multiple products from one product group at once.<br />
 
|style="padding: 10px 0px 15px 15px;"|You can configure multiple products from one product group at once.<br />
−
All product groups containing at least one supported module will be displayed in our module → '' 'Module Configuration' '' tab.<br />
+
All product groups containing at least one supported module will be displayed in our module → '' 'Control Panels' '' tab.<br />
 
Press '' 'Advanced Settings' '' next to the desired product group to proceed.
 
Press '' 'Advanced Settings' '' next to the desired product group to proceed.
 
|}
 
|}
Line 171: Line 209:
 
|}
 
|}
 
{|
 
{|
−
|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;"|On the following screen you can see unban functionality settings for a product group.<br />
−
As you may have noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended For WHMCS' ''.<br />
+
As you may have noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended For WHMCS'. ''<br />
−
It means that products in selected product group are using both cPanel and cPanel Extended For WHMCS modules.<br />
+
It means that products in a 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.
 
This way you can set up unban functionality for cPanel and cPanel Extended products separately.
 
|}
 
|}
Line 180: Line 218:
 
|}
 
|}
 
{|
 
{|
−
|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;"|Product group settings apply only to disabled products or products marked as '' 'Uses Group Settings'. ''<br />
 
Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.<br />
 
Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.<br />
 
Products for which group settings are applied to are marked with '' 'Uses Group Settings' '' as shown on the following screen.
 
Products for which group settings are applied to are marked with '' 'Uses Group Settings' '' as shown on the following screen.
Line 188: Line 226:
 
|}
 
|}
 
{|
 
{|
−
|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;"|You can force group settings for all products in that group through using '' 'Set For All' '' button.<br />
 
''Note: '' 'Set For All' '' will force group settings only for enabled products.''<br />
 
''Note: '' 'Set For All' '' will force group settings only for enabled products.''<br />
−
''In order to apply group settings to all products, disable group, enable it and press '' 'Set For All' ''.''
+
''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:UB_12_2_2.png]]
 
|}
 
|}
−
 
+
==VPS/Dedicated Servers==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|'''''VPS/Dedicated Servers''''' tab allows you to set configuration for default submodules and all available products.<br/> Unban IP addresses in cPanel set up on any VPS or dedicated server.
 +
|}
 +
===Default Submodules Settings===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Select desired value from '' 'Unban Type' '' and enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' text area.<br />
 +
What is more, you can allow your clients to unban any IP address if you unmark checkbox as shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18.png]]
 +
|}
 +
===Available products===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Check selected product and press '' 'Advanced Settings'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_18_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Enable unban functionality for that product. Now you can either choose to use '' 'Default' '' settings (declared for default submodule)<br/>
 +
or configure new settings for the product separately. Remember to '' 'Save Changes'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18_2.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;"|'' 'Unban Users' '' tab allows you to unban your clients IP address from any of the external servers 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 accounts as well as custom IP address. Press '' 'Unban' '' as shown on the following screen.<br />
−
''Note: You will be able to unban only from external servers enabled at '' 'Unban Center For WHMCS' '' → '' 'Module Configuration' ''.''
+
''Note: You will be able to unban only from external servers enabled at '' 'Unban Center For WHMCS' '' → '' 'Control Panels' '' and '' 'VPS/Dedicated Servers'. ''
 
|}
 
|}
 
{|
 
{|
Line 206: Line 269:
 
|}
 
|}
 
{|
 
{|
−
|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 '' 'VPS host Address', 'Username', 'Password' '' will be filled in automatically. Select '' 'SSL Connection' ''' if you wish.<br/>
 +
''Note! These details will appear only in case of VPS products used by the client.''
 
|}
 
|}
 
{|
 
{|
Line 212: Line 276:
 
|}
 
|}
 
{|
 
{|
−
|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 now check the status of the client's IP. Press '' 'Check Client IP Address'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_41.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;"|Alternatively, fill in IP address to check.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_42.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|To unban client's IP, fill in the data just like in case of checking IP status and press '' 'Unban Client IP Address'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_43.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can also type in a given IP and press '' Unban' '' then.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_44.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|To unban multiple accounts at once, select checkbox near accounts to unban and press '' 'Unban Selected' '' as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_6.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_6.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;"|Please note that client area button '' 'Unban Your IP' '' is visible only if you have properly inserted [http://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Integration_Code integration codes]<br/>
−
Press '' 'Unban Center' '' in order to continue.
+
Let's proceed to the client area → '' 'Services' ''  → '' 'My Services' '' in order to try out unban action.<br />
 +
Press '' 'Unban Your IP' '' to proceed to '' 'Unban Center'. ''
 
|}
 
|}
 
{|
 
{|
Line 233: Line 315:
 
|}
 
|}
 
{|
 
{|
−
|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 product for which you want to perform unban IP address action.
 
|}
 
|}
 
{|
 
{|
Line 239: Line 321:
 
|}
 
|}
 
{|
 
{|
−
|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;"|You will see a full product name and its status, underneath you will find IP address to be unbanned and VPS host details (provided you have selected a VPS product).
−
Finish through pressing '' 'Unban' '' button.
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Check if your IP is banned or unban it immediately. Once the action is completed you will be notified about the results.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:UB_15x.png]]
 
|}
 
|}
 
==Logs==
 
==Logs==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found at '' 'Unban Center' '' → '' 'Logs' '' tab.<br />
 
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found at '' 'Unban Center' '' → '' 'Logs' '' tab.<br />
−
In addition, you can find here information related to user or admin who requested unban action and its date.
+
You can find here information related to user or admin who requested unban action and its date.<br/>
 +
Use  '' 'Clear Logs' '' button to delete old and unnecessary log entries.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_16.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_16.png]]
 
|}
 
|}
−
 
 
==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 allowing 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 '' 'your_whmcs/modules/addons/unbanCenter/submodules/' ''.<br />
 
Owing to that, you are able to make your offer much more competitive and extend it to other systems and control panels.
 
Owing to that, you are able to make your offer much more competitive and extend it to other systems and control panels.
Line 267: Line 354:
 
{|'  
 
{|'  
 
|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 copy of '' 'sample' '' folder to the name used by 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's say folder with module to integrate with Unban Center For WHMCS, which is located in '' 'your_whmcs/modules/servers/' '' is named '' 'dummyIntegration' ''.<br />
 
For that case, your folder at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' '' should be named '' 'dummyIntegration' ''.<br />
 
For that case, your folder at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' '' should be named '' 'dummyIntegration' ''.<br />
 
File '' 'sampleUnbanSubmodule' '' located at previously renamed folder should be renamed to '' 'dummyIntegrationUnbanModule' ''.<br />
 
File '' 'sampleUnbanSubmodule' '' located at previously renamed folder should be renamed to '' 'dummyIntegrationUnbanModule' ''.<br />
 
Afterwards, edit file '' 'dummyIntegrationUnbanModule' '' and follow instruction housed inside.
 
Afterwards, edit file '' 'dummyIntegrationUnbanModule' '' and follow instruction housed inside.
 
|}
 
|}
−
 
 
=Tips=
 
=Tips=
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|
 
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
Line 283: Line 368:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. After update some functionalities are not working properly.<br />
+
|style="padding: 0px 0px 5px 15px;"|2. After update some functionalities are not working properly.<br />
 
''Cause:'' Your browser store old JavaScript in its cache.<br />
 
''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].
 
''Solution:'' Reload full page by using key combination to [bypass your cache http://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|3. When upgrading your module to the latest version to run on WHMCS V6.x.x, remember to insert appropriate integration code for the template you are using.<br/>
 +
There is a different code for template ''Five'' and for template ''Six.''
 
|}
 
|}

Revision as of 10:36, 17 August 2015

Contents

About Unban Center For WHMCS

Unban Center For WHMCS allows your clients to easily unban IP addresses in cPanel directly from your WHMCS client area.

Additionally, the module lets you create your own submodules in order to integrate them with other systems and control panels.

  • Client Area Features:
✔ Automatically Detect And Unban IP Address From:
✔ Control Panel
✔ Control Panel Hosted On Client's VPS
✔ Check If IP Address Is Banned
✔ Show Reason Of Ban
✔ View Time Until Next Available Unban Action
  • Admin Area Features:
✔ Configure Per Product:
✔ Enable/Disable Unban Ability
✔ Configure Unban Behavior
✔ Define Black List Of IP Addresses - Protected From Unban Action
✔ Define Unban Delay - Protection From Abuse
✔ Define If Customer Can Unban Other IP Address Than Their Current One
✔ Set Up Default Settings
✔ Define Products Using Product Group Settings - Control Panel
✔ Define Products Using Default Settings - VPS / Dedicated Server
✔ Unban Single Client From Chosen Product
✔ Unban Multiple Clients From Chosen Control Panel
✔ Check If Client IP Address Is Banned
✔ View And Clear Logs
  • General Info:
✔ Developer Friendly Creation Of Additional Submodules
✔ Supports cPanel & cPanel Extended For WHMCS
✔ Multi-Language Support
✔ Supports Templates Five and Six
✔ Supports WHMCS V5 and V6

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.

1. Log in to your client area and download Unban Center For WHMCS.
UB 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

UB 2.png
3. When you install Unban Center for the first time you have to rename 'license_RENAME.php' file.

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

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

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

UB 4.png
5. 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 'Activate' button.

UB 5.png
6. In the next step you need to permit access to this module.

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

UB 6.png
7. Go to 'Addons' → 'Unban Center' → 'Integration Code' tab and follow the instructions of integration to allow access from the client area.

The integration codes differ depending on the WHMCS version and template you are using.
Once you perform the integration properly, the status of the integration will change to Done.

If you run Unban Center on WHMCS V5.x then you will have to copy and paste the below code:

UB 7.png
If you run Unban Center on the latest WHMCS V6.x.x then you will have to firstly decide which template you use:
  • Integration code for WHMCS V6.x.x, template SIX
UB 7 1.png
  • Integration code for WHMCS V6.x.x, template FIVE
UB 7 2.png
8. You have just successfully installed Unban Center For WHMCS!

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

UB 8.png

Configuration and Management

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

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

Control Panels

At the 'Control Panels' tab you can easily enable and configure unban action for all or for chosen servers only.

Configuration of Single Product

Let's show you how to enable unban functionality for cPanel Extended product.

Start with marking 'Enabled' checkbox and define how often your client will be able to perform unban action on specific product.
Afterwards, press 'Advanced Settings'.

UB 11.png
Next, select desired value from 'Unban Type', you can choose form:
  • Unban on CSF
  • Unban on cPHulk (Blacklist Management and History Reports)
  • Unban on both of the above

Enter IP addresses that will be unable to be unbanned into 'Black List of IP Addresses' textbox.
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.
Confirm those settings through pressing 'Save Changes' button.

UB 12.png

Configuration of Multiple Products

You can configure multiple products from one product group at once.

All product groups containing at least one supported module will be displayed in our module → 'Control Panels' tab.
Press 'Advanced Settings' next to the desired product group to proceed.

UB 12 1.png
On the following screen you can see unban functionality settings for a product group.

As you may have noticed there are two tabs, 'cPanel' and 'cPanel Extended For WHMCS'.
It means that products in a selected product group are using both cPanel and cPanel Extended For WHMCS modules.
This way you can set up unban functionality for cPanel and cPanel Extended products separately.

UB 12 2.png
Product group settings apply only to disabled products or products marked as 'Uses Group Settings'.

Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.
Products for which group settings are applied to are marked with 'Uses Group Settings' as shown on the following screen.

UB 12 2 1.png
You can force group settings for all products in that group through using 'Set For All' button.

Note: 'Set For All' will force group settings only for enabled products.
In order to apply group settings to all products, disable group, enable it and press 'Set For All'.

UB 12 2 2.png

VPS/Dedicated Servers

VPS/Dedicated Servers tab allows you to set configuration for default submodules and all available products.
Unban IP addresses in cPanel set up on any VPS or dedicated server.

Default Submodules Settings

Select desired value from 'Unban Type' and enter IP addresses that will be unable to be unbanned into 'Black List of IP Addresses' text area.

What is more, you can allow your clients to unban any IP address if you unmark checkbox as shown on the following screen.

UB 18.png

Available products

Check selected product and press 'Advanced Settings'.
UB 18 1.png
Enable unban functionality for that product. Now you can either choose to use 'Default' settings (declared for default submodule)

or configure new settings for the product separately. Remember to 'Save Changes'.

UB 18 2.png

Unban Users

'Unban Users' tab allows you to unban your clients IP address from any of the external servers on which they own an account.

You can unban IP address assigned to your client accounts as well as custom IP address. Press 'Unban' as shown on the following screen.
Note: You will be able to unban only from external servers enabled at 'Unban Center For WHMCS' → 'Control Panels' and 'VPS/Dedicated Servers'.

UB 12 3.png
Data on 'VPS host Address', 'Username', 'Password' will be filled in automatically. Select 'SSL Connection' ' if you wish.

Note! These details will appear only in case of VPS products used by the client.

UB 12 4.png
You may now check the status of the client's IP. Press 'Check Client IP Address'.
UB 12 41.png
Alternatively, fill in IP address to check.
UB 12 42.png
To unban client's IP, fill in the data just like in case of checking IP status and press 'Unban Client IP Address'.
UB 12 43.png
You can also type in a given IP and press Unban' then.
UB 12 44.png
To unban multiple accounts at once, select checkbox near accounts to unban and press 'Unban Selected' as shown on the screen below.
UB 12 6.png

Client Area

Please note that client area button 'Unban Your IP' is visible only if you have properly inserted integration codes

Let's proceed to the client area → 'Services' → 'My Services' in order to try out unban action.
Press 'Unban Your IP' to proceed to 'Unban Center'.

UB 13.png
Now, select product for which you want to perform unban IP address action.
UB 14.png
You will see a full product name and its status, underneath you will find IP address to be unbanned and VPS host details (provided you have selected a VPS product).
UB 15.png
Check if your IP is banned or unban it immediately. Once the action is completed you will be notified about the results.
UB 15x.png

Logs

All unban requests and their results can be found at 'Unban Center' → 'Logs' tab.

You can find here information related to user or admin who requested unban action and its date.
Use 'Clear Logs' button to delete old and unnecessary log entries.

UB 16.png

Creating 3rd Party Submodule

The main goal of Unban Center For WHMCS is allowing 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 'your_whmcs/modules/addons/unbanCenter/submodules/' .
Owing to that, you are able to make your offer much more competitive and extend it to other systems and control panels.

UB 17.png
Start with renaming copy of 'sample' folder to the name used by 3rd party module.

Let's say folder with module to integrate with Unban Center For WHMCS, which is located in 'your_whmcs/modules/servers/' is named 'dummyIntegration' .
For that case, your folder at 'your_whmcs/modules/addons/unbanCenter/submodules/' should be named 'dummyIntegration' .
File 'sampleUnbanSubmodule' located at previously renamed folder should be renamed to 'dummyIntegrationUnbanModule' .
Afterwards, edit file 'dummyIntegrationUnbanModule' and follow instruction housed inside.

Tips

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 store old JavaScript in its cache.
Solution: Reload full page by using key combination to [bypass your cache http://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache].

3. When upgrading your module to the latest version to run on WHMCS V6.x.x, remember to insert appropriate integration code for the template you are using.

There is a different code for template Five and for template Six.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Unban_Center_For_WHMCS&oldid=18955"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Unban Center For WHMCS