Server Allocator For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
(→Installation and Configuration) |
(→About Server Allocator For WHMCS) |
||
| (16 intermediate revisions by 4 users not shown) | |||
| Line 4: | Line 4: | ||
=About [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS]= | =About [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS]= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 10px 0px;"|'''Server Allocator For WHMCS''' will | + | |style="padding: 10px 0px 10px 0px;"|'''Server Allocator For WHMCS''', much like a load balancer, will automatically match servers to your clients' products, guided by the criteria they specified when ordering.<br /> |
| − | + | The module lets you create and configure your own switching rules, split them into groups and assign to them product groups as well as specified servers.<br /> | |
| − | + | The rules offer great flexibility as they rely on selected configurable options, product addons, custom fields, or even individual clients. | |
|} | |} | ||
<!-- fixed --> | <!-- fixed --> | ||
*'''Admin Area Features:''' | *'''Admin Area Features:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ Add/Edit/Remove Switching Rules | + | |style="padding: 10px 0px 0px 30px;"|✔ Add/Edit/Remove Switching Rules And Their Groups |
|} | |} | ||
{| | {| | ||
| Line 24: | Line 24: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 30px;"|✔ Set Load Balancing Allocation Type To Server With Most Or Least Free Space | |style="padding: 0px 0px 0px 30px;"|✔ Set Load Balancing Allocation Type To Server With Most Or Least Free Space | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Block Order If Server Is Full | ||
|} | |} | ||
{| | {| | ||
| Line 34: | Line 37: | ||
*'''Supported Rule Definitions:''' | *'''Supported Rule Definitions:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ Configurable Options | + | |style="padding: 10px 0px 0px 30px;"|✔ Clients |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Configurable Options | ||
|} | |} | ||
{| | {| | ||
| Line 53: | Line 59: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 7.4 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.11 Back To WHMCS V8.8 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/server-allocator#open-source-version Open Source Version] | + | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V13 Or 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/server-allocator#open-source-version Open Source Version] | ||
|} | |} | ||
| Line 82: | Line 91: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> | |style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> | ||
| − | The first one | + | The first one supports PHP 5.6 up to PHP 7.1, and the second one addresses PHP 7.2 up to PHP 7.4.<br/> |
| − | '''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released | + | '''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released anymore. Find more info [http://php.net/supported-versions.php here].'' |
|} | |} | ||
{| | {| | ||
| Line 114: | Line 123: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br/> | |style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br/> | ||
| − | Log in to your WHMCS admin area. Go to the '' 'Setup' '' → '' 'Addon Modules' ''. | + | Log in to your WHMCS admin area. Go to the '' 'Setup' '' → '' 'Addon Modules' ''. Afterward, find '' 'Server Allocator' '' and press '' 'Activate' '' button. |
|} | |} | ||
{| | {| | ||
| Line 120: | Line 129: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step, you need to permit access to this module.'''<br /> |
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'.'' | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'.'' | ||
|} | |} | ||
| Line 132: | Line 141: | ||
=Management= | =Management= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|Server Allocator For WHMCS allows you to automatically switch to wanted server upon specific product configuration. | + | |style="padding: 10px 0px 15px 15px;"|Server Allocator For WHMCS allows you to automatically switch to the wanted server upon specific product configuration. |
|} | |} | ||
{| | {| | ||
| Line 139: | Line 148: | ||
==Add Group== | ==Add Group== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|In order to configure switching rules, proceed with creating | + | |style="padding: 10px 0px 15px 15px;"|In order to configure switching rules, proceed with creating a new group.<br/> |
Press '' 'Add Group' '' to proceed. | Press '' 'Add Group' '' to proceed. | ||
|} | |} | ||
| Line 147: | Line 156: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Fill in group name and select desired product groups.<br/> | |style="padding: 0px 0px 15px 15px;"|Fill in group name and select desired product groups.<br/> | ||
| − | Additionally, select default servers (Ctrl+mouse click for multi select) if you wish to redefine default servers.<br/> | + | Additionally, select default servers (Ctrl+mouse click for multi-select) if you wish to redefine default servers.<br/> |
| − | Press '' 'Save' '' to create group. | + | Press '' 'Save' '' to create a group. |
|} | |} | ||
{| | {| | ||
| Line 157: | Line 166: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Previously created group currently does not affect the system at all.<br/> | |style="padding: 10px 0px 15px 15px;"|Previously created group currently does not affect the system at all.<br/> | ||
| − | Let's change that | + | Let's change that by adding a new rule. Press '' 'Add Rule' '' to proceed. |
|} | |} | ||
{| | {| | ||
| Line 163: | Line 172: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|In the next step select server type that the switch will apply to.<br/> | + | |style="padding: 0px 0px 15px 15px;"|In the next step select the server type that the switch will apply to.<br/> |
Press '' 'Next'.'' | Press '' 'Next'.'' | ||
|} | |} | ||
| Line 172: | Line 181: | ||
|style="padding: 0px 0px 15px 15px;"|Each rule can have multiple rule definitions.<br/> | |style="padding: 0px 0px 15px 15px;"|Each rule can have multiple rule definitions.<br/> | ||
'''Important:''' Switch will be made only if all of the rule definitions are met.<br/> | '''Important:''' Switch will be made only if all of the rule definitions are met.<br/> | ||
| − | Let's add first rule definitions, adding it starts with selecting rule definitions type.<br/> | + | Let's add the first rule definitions, adding it starts with selecting the rule definitions type.<br/> |
| − | To do so, press '' 'Add Definition' '' and choose desired one. | + | To do so, press '' 'Add Definition' '' and choose the desired one. |
|} | |} | ||
{| | {| | ||
| Line 179: | Line 188: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|For the purpose of this documentation, we have chosen configurable option rule definition.<br/> | + | |style="padding: 0px 0px 15px 15px;"|For the purpose of this documentation, we have chosen a configurable option rule definition.<br/> |
| − | Now, we have to select specific configurable option and its value which needs to be chosen. | + | Now, we have to select a specific configurable option and its value which needs to be chosen. |
|} | |} | ||
{| | {| | ||
| Line 201: | Line 210: | ||
==Rule Management== | ==Rule Management== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"|Each group and rule can be modified and removed at any time | + | |style="padding: 10px 0px 20px 15px;"|Each group and rule can be modified and removed at any time by using buttons marked on the following screen. |
|} | |} | ||
{| | {| | ||
| Line 207: | Line 216: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Press '' 'Links' '' next to desired rule to view the list of links. | + | |style="padding: 0px 0px 20px 15px;"|Press '' 'Links' '' next to the desired rule to view the list of links. |
|} | |} | ||
{| | {| | ||
| Line 213: | Line 222: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Each of them leads to the order form with product configured according to defined rule. | + | |style="padding: 0px 0px 20px 15px;"|Each of them leads to the order form with the product configured according to the defined rule. |
|} | |} | ||
{| | {| | ||
| Line 221: | Line 230: | ||
==Sample Orders== | ==Sample Orders== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"|In this section we will show you how our module works on an exemplary rule shown below. | + | |style="padding: 10px 0px 20px 15px;"|In this section, we will show you how our module works on an exemplary rule shown below. |
|} | |} | ||
{| | {| | ||
| Line 229: | Line 238: | ||
{| | {| | ||
|style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving '' 'cPanel SSD - 99.9' '' server.<br/> | |style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving '' 'cPanel SSD - 99.9' '' server.<br/> | ||
| − | Using this configuration, client pays additionally for 'Based On SSD' addon. | + | Using this configuration, the client pays additionally for 'Based On SSD' addon. |
|} | |} | ||
{| | {| | ||
| Line 245: | Line 254: | ||
{| | {| | ||
|style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving '' 'cPanel SSD - 99.99' '' server.<br/> | |style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving '' 'cPanel SSD - 99.99' '' server.<br/> | ||
| − | + | The client must pay for 'Based On SSD' as well as for higher guaranteed uptime. | |
|} | |} | ||
{| | {| | ||
| Line 260: | Line 269: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Let us order a product without '' 'Based On SSD' '' addon and with default uptime.<br/> | |style="padding: 10px 0px 15px 15px;"|Let us order a product without '' 'Based On SSD' '' addon and with default uptime.<br/> | ||
| − | This should result in assigning default 'cPanel - 99.9' server. | + | This should result in assigning the default 'cPanel - 99.9' server. |
|} | |} | ||
{| | {| | ||
| Line 266: | Line 275: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|As you can see, switch has not been made and hosting is using default group server. | + | |style="padding: 0px 0px 20px 15px;"|As you can see, the switch has not been made and hosting is using the default group server. |
|} | |} | ||
| Line 280: | Line 289: | ||
=Update Instructions= | =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/> |
| − | + | Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there. | |
| − | + | |} | |
| + | =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/server-allocator#open-source-version Open Source version] of your Server Allocator 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. | ||
|} | |} | ||
| Line 292: | Line 308: | ||
|style="padding: 0px 0px 30px 15px;"|2. You are unable to add a product addon/configurable option/custom field to the rule.<br /> | |style="padding: 0px 0px 30px 15px;"|2. You are unable to add a product addon/configurable option/custom field to the rule.<br /> | ||
'''Reason:''' An item has to be assigned to a product which: | '''Reason:''' An item has to be assigned to a product which: | ||
| − | *Is assigned to a product group included | + | *Is assigned to a product group included in the switching group. |
*Product is of a type selected during adding a new rule. | *Product is of a type selected during adding a new rule. | ||
'''Solution:''' Ensure that an item you are trying to add is assigned to a correct product. | '''Solution:''' Ensure that an item you are trying to add is assigned to a correct product. | ||
|} | |} | ||
Latest revision as of 14:32, 13 September 2024
Contents |
[edit] About Server Allocator For WHMCS
| Server Allocator For WHMCS, much like a load balancer, will automatically match servers to your clients' products, guided by the criteria they specified when ordering. The module lets you create and configure your own switching rules, split them into groups and assign to them product groups as well as specified servers. |
- Admin Area Features:
| ✔ Add/Edit/Remove Switching Rules And Their Groups |
| ✔ Add Multiple Conditions/Products/Servers To Switching Rule |
| ✔ Assign Multiple Rules To Rules Group |
| ✔ Set Default Servers To Rules Group - Used If No Rule Is Applied |
| ✔ Set Load Balancing Allocation Type To Server With Most Or Least Free Space |
| ✔ Block Order If Server Is Full |
| ✔ Access Links To Order Form Of Products Configured According To Specified Rule |
- Client Area Features:
| ✔ Switch Assigned Server Automatically During Ordering Product - Depending On Applied Rule |
- Supported Rule Definitions:
| ✔ Clients |
| ✔ Configurable Options |
| ✔ Custom Fields |
| ✔ Product Addons |
- General Info:
| ✔ Supports All Server Types |
| ✔ Supports Most Provisioning Modules |
| ✔ Multi-Language Support |
| ✔ Supports PHP 8.2 Back To PHP 7.4 |
| ✔ Supports WHMCS V8.11 Back To WHMCS V8.8 |
| ✔ Requires ionCube Loader V13 Or Later |
| ✔ Easy Module Upgrade To Open Source Version |
[edit] Installation and Configuration
| This tutorial will show you how to successfully install and configure Server Allocator For WHMCS. We will guide you step by step through the whole installation and configuration process. |
| 1. Log in to our client area and download the module. |
|
| 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.2 and later. |
|
| Previous updates of the module may contain two packages dedicated to various PHP versions. The first one supports PHP 5.6 up to PHP 7.1, and the second one addresses PHP 7.2 up to PHP 7.4. |
|
| 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. |
|
| 4. When you install Server Allocator For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/serverswitcher/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
|
| 5. 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 in our client area → 'My Products'. |
|
| 6. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Go to the 'Setup' → 'Addon Modules' . Afterward, find 'Server Allocator' and press 'Activate' button. |
|
| 7. In the next step, you need to permit access to this module. To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'. |
|
| 8. You have just successfully installed Server Allocator For WHMCS! |
[edit] Management
| Server Allocator For WHMCS allows you to automatically switch to the wanted server upon specific product configuration. |
|
[edit] Add Group
| In order to configure switching rules, proceed with creating a new group. Press 'Add Group' to proceed. |
|
| Fill in group name and select desired product groups. Additionally, select default servers (Ctrl+mouse click for multi-select) if you wish to redefine default servers. |
|
[edit] Group Management
| Previously created group currently does not affect the system at all. Let's change that by adding a new rule. Press 'Add Rule' to proceed. |
|
| In the next step select the server type that the switch will apply to. Press 'Next'. |
|
| Each rule can have multiple rule definitions. Important: Switch will be made only if all of the rule definitions are met. |
|
| For the purpose of this documentation, we have chosen a configurable option rule definition. Now, we have to select a specific configurable option and its value which needs to be chosen. |
|
| Let's add one more rule definition, which in this case will be using product addon. Press 'Add Definition' → 'Addon' and choose product addon. |
|
| Now, define the load balancing allocation type. Decide if the server with the most or least free space shall be used and press 'Save Changes' button. |
|
[edit] Rule Management
| Each group and rule can be modified and removed at any time by using buttons marked on the following screen. |
|
| Press 'Links' next to the desired rule to view the list of links. |
|
| Each of them leads to the order form with the product configured according to the defined rule. |
|
[edit] Sample Orders
| In this section, we will show you how our module works on an exemplary rule shown below. |
|
[edit] First Order
| Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.9' server. Using this configuration, the client pays additionally for 'Based On SSD' addon. |
|
| The switch will be made upon ordering the product (order made from the client area) or accepting the order (order made from the admin area). Hosting with a switched server is displayed on the following screen. |
|
[edit] Second Order
| Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.99' server. The client must pay for 'Based On SSD' as well as for higher guaranteed uptime. |
|
| As displayed on the following screen, the switch has been made successfully. |
|
[edit] Third Order
| Let us order a product without 'Based On SSD' addon and with default uptime. This should result in assigning the default 'cPanel - 99.9' server. |
|
| As you can see, the switch has not been made and hosting is using the default group server. |
|
[edit] Tips
| 1. In case none of the configuration settings meet any rule, the product will be assigned to a default server. |
[edit] Update Instructions
| An essential guidance through the process of updating the module is offered here. Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues. |
[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 Server Allocator For WHMCS module to unlock these benefits. 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. You are unable to add a product addon/configurable option/custom field to the rule. Reason: An item has to be assigned to a product which:
Solution: Ensure that an item you are trying to add is assigned to a correct product. |