Personal tools
Namespaces

Variants
Actions

Unban Center For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Module Configuration)
Line 3: Line 3:
  
 
=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]=
 +
<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 5px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in cPanel directly from your WHMCS client area.
Line 13: Line 15:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Developer Friendly Creation Of Additional Submodules
 
|style="padding: 0px 0px 0px 30px;"|✔ Developer Friendly Creation Of Additional Submodules
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Detect Server Type And Unban Accordingly
 
|}
 
|}
 
{|
 
{|
Line 23: Line 28:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Enable/Disable Unban Actions For Selected Products
 
|style="padding: 10px 0px 0px 30px;"|✔ Enable/Disable Unban Actions For Selected Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Unban Functionality Per Product Group
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Flexible Unban Delay - Protection From Abuse
 
|style="padding: 0px 0px 0px 30px;"|✔ Flexible Unban Delay - Protection From Abuse
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple IP Addresses At Once
 
|}
 
|}
 
{|
 
{|
Line 32: Line 43:
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 10px 30px;"|✔ Unban IP Address Of Selected Product
+
|style="padding: 10px 0px 00px 30px;"|✔ Unban IP Address Of Selected Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ View Information About Cause Of Ban
 
|}
 
|}
 
*'''Additionally:'''
 
*'''Additionally:'''
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended For WHMCS]
 
|}
 
|}
 
{|
 
{|
Line 122: Line 139:
 
==Module Configuration==
 
==Module Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At the '' 'Module Configuration' '' tab you can easily enable and configure unban action.<br />
+
|style="padding: 10px 0px 15px 15px;"|At the '' 'Module Configuration' '' tab you can easily enable and configure unban action.
−
Let's enable unban action for cPanel Extended product.<br />
+
|}
 +
===Configuration of Single Product===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Let's enable unban action for cPanel Extended product.<br />
 
Start of marking '' 'Enabled' '' checkbox and define how often your client will be able to perform unban action at specific product.<br />
 
Start of marking '' 'Enabled' '' checkbox and define how often your client will be able to perform unban action at specific product.<br />
 
Afterwards, press '' 'Advanced Settings' ''.
 
Afterwards, press '' 'Advanced Settings' ''.
Line 132: Line 152:
 
{|
 
{|
 
|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;"|Next, select desired value from '' 'Unban Type' '' and enter IP addresses protected from unban action 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 />
 
Confirm those settings through pressing '' 'Save Changes' '' button.
 
Confirm those settings through pressing '' 'Save Changes' '' button.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
 +
|}
 +
 +
===Configuration of Multiple Products===
 +
{|
 +
|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 at our module → '' 'Module Configuration' '' tab.<br />
 +
Press '' 'Advanced Settings' '' next to desired product group to proceed.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|On the following screen you can see unban functionality settings for product group.<br />
 +
As you may noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended' ''.<br />
 +
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: 10px 0px 15px 15px;"|Product group settings works only for disabled products.<br />
 +
Therefore, unban feature settings of product group will not be applied to modified product even if he belongs to that group.<br />
 +
Products for which group settings are applied are marked with '' 'Uses Group Settings' '' as shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_2_1.png]]
 +
|}
 +
 +
==Unban Users==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'' 'Unban Users' '' tab allows you to unban your client IP address from any of external server at which he own an account.<br />
 +
You can unban IP address assigned to your client account 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' ''.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Unban Client IP Address' '' to unban IP assigned to his account.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Alternatively, fill IP address to unban and press '' 'Unban' '' as shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_5.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 30px 25px;"|[[File:UB_12_6.png]]
 
|}
 
|}
  
Line 153: Line 229:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Finish through typing IP address to unban in the field and press '' 'Unban' '' button.
+
|style="padding: 0px 0px 20px 15px;"|If your client IP address is banned on external server, reason of ban will be displayed as shown on the following screen.<br />
 +
Finish through pressing '' 'Unban' '' button.
 
|}
 
|}
 
{|
 
{|

Revision as of 09:19, 9 July 2014

Contents

About Unban Center For WHMCS

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconveniences.

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 to integrate with other systems and control panels.

  • Features:
✔ Modularity - Each Feature Is Based On Used Submodule
✔ Developer Friendly Creation Of Additional Submodules
✔ Automatically Detect Server Type And Unban Accordingly
✔ Configuration Of Unban Type
✔ Black List Of IP Addresses - Protection From Unban Actions
  • Admin Area Features:
✔ Enable/Disable Unban Actions For Selected Products
✔ Configure Unban Functionality Per Product Group
✔ Flexible Unban Delay - Protection From Abuse
✔ Unban Multiple IP Addresses At Once
✔ Logs
  • Client Area Features:
✔ Unban IP Address Of Selected Product
✔ View Information About Cause Of Ban
  • Additionally:
✔ Multi-Language Support
✔ Supports cPanel & cPanel Extended For WHMCS
✔ Supports WHMCS V5 and Later

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 at '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 a previously renamed 'license.php' file .

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' .

UB 4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to the '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 the 'Addons' → 'Unban Center' → 'Integration Code' tab and follow the instruction of integration.

As soon as you place the integration code in a correct location, the status of integration will change from 'Undone' to 'Done' .

UB 7.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 ability to easily unban desired IP addresses from external server.

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

Integration Code

Placing integration code is necessity, otherwise your clients will not be able even to see 'Unban' button.

Integration code can be found at 'Unban Center' addon → 'Integration Code' tab.
As soon as you place integration code correctly, its status will be changed to 'Done' .
Correctly placed code is shown on the following screen.

File:UB 10.png

Module Configuration

At the 'Module Configuration' tab you can easily enable and configure unban action.

Configuration of Single Product

Let's enable unban action for cPanel Extended product.

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

UB 11.png
Next, select desired value from 'Unban Type' and enter IP addresses protected from unban action 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 at our module → 'Module Configuration' tab.
Press 'Advanced Settings' next to desired product group to proceed.

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

As you may noticed there are two tabs, 'cPanel' and 'cPanel Extended' .
It means that products in 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 works only for disabled products.

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

UB 12 2 1.png

Unban Users

'Unban Users' tab allows you to unban your client IP address from any of external server at which he own an account.

You can unban IP address assigned to your client account 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' → 'Module Configuration' .

UB 12 3.png
Afterwards, press 'Unban Client IP Address' to unban IP assigned to his account.
UB 12 4.png
Alternatively, fill IP address to unban and press 'Unban' as shown on the following screen.
File:UB 12 5.png
To unban multiple accounts at once, select checkbox near accounts to unban and press 'Unban All' as shown on the screen below.
UB 12 6.png

Client Area

Let's proceed to the client area → 'Services' → 'My Services' in order to try out unban action.

Press 'Unban Center' in order to continue.

UB 13.png
Now, select product for which you want to perform unban IP address action and press 'Next Step' .
UB 14.png
If your client IP address is banned on external server, reason of ban will be displayed as shown on the following screen.

Finish through pressing 'Unban' button.

UB 15.png

Logs

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

In addition to that, you can find here information related to user who requested unban action and its date.

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 to submodule itself is located inside examplary submodule.
It can be found at 'your_whmcs/modules/addons/unbanCenter/submodules/' .
Owing to that, you are able to made your offer much more competitive and extend it to other systems and control panels.

UB 17.png
Start by 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 at '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 is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Unban_Center_For_WHMCS&oldid=13030"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Unban Center For WHMCS