SolusVM Extended Cloud For WHMCS
|SolusVM Extended Cloud For WHMCS will allow your clients to manage multiple virtual servers directly in your WHMCS.|
Your customers will be able to freely add, resize and upgrade their servers within the limits of resources defined by you.
- Admin Area Features:
|✔ Create/Suspend/Unsuspend/Terminate User Account|
|✔ View Server Status|
|✔ View Graphs: Traffic, Load, Memory|
|✔ Change Server Password|
|✔ Define Product Total Resource Limits:|
|✔ Dynamically - Using Configurable Options|
|✔ Statically - Using 'Module Settings' Fields|
|✔ Define Resource Range For VPS Creation|
|✔ Configure Client Area Features Per Product|
|✔ Define OS Templates Available For Rebuild|
|✔ Select Kernels For Rescue Mode|
|✔ Configure Friendly Names For OS Templates And Nodes|
|✔ Toggle Root Password Storing In System Database|
|✔ Toggle Root Password Change After Server Creation|
|✔ Run API Connection Test|
- Client Area Features:
|✔ Create/Edit/Delete Server|
|✔ Boot/Reboot/Shutdown/Rebuild Server|
|✔ View Available Resources|
|✔ Toggle TUN/TAP And PAE|
|✔ Toggle PXE (Preboot Execution Environment)|
|✔ Toggle Rescue Mode With Chosen Kernel|
|✔ Change Password: Root, Client, SSH Console And VNC Console|
|✔ Change Boot Order|
|✔ View Server Status|
|✔ View Graphs: Traffic, Load, Memory|
|✔ Access SSH Console - OpenVZ And Xen Only|
|✔ Access VNC Console - KVM And Xen HVM Only|
|✔ Access NoVNC HTML5 Console - KVM And Xen HVM Only|
|✔ Access HTML5 Serial Console - OpenVZ And Xen Only|
|✔ Log In To Control Panel|
|✔ View Friendly Names Of OS Templates|
|✔ Send Email Templates After Creation Of Server Based On Its Type|
|✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely|
- Available Configurable Options:
|✔ Memory Limit|
|✔ Storage Limit|
|✔ Bandwidth Limit|
|✔ CPU Cores Limit|
|✔ IPv4 Addresses Limit|
|✔ Network Speed|
- General Info:
|✔ Supports OpenVZ, Xen and KVM Virtualization|
|✔ Integrated With DNS Manager For WHMCS - Supports PowerDNS (read more)|
|✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing (read more)|
|✔ Multi-Language Support|
|✔ Supports PHP 5.6 Up To PHP 7.3|
|✔ Supports WHMCS Template Six|
|✔ Supports WHMCS V7.5 And Later|
|✔ Easy Module Upgrade To Open Source Version|
Installation and Configuration
|In this tutorial we will show you how to successfully install SolusVM Extended Cloud 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.1 and later.
|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.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
| Important: This situation does not affect [the open source version of this module which can be applied to any PHP from version 5.6 and later.|
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
|3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.|
The content of the chosen PHP version files to upload should look like this.
|4. When you install SolusVM Extended Cloud For WHMCS for the first time you have to rename 'license_RENAME.php' file.|
File is located in 'modules/servers/solusvmExtendedCloud/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. Finally, it is suggested to set a cron task in the crontab in order to update the current usage (once per hour suggested).
@hourly php -q /your_whmcs/modules/servers/solusvmExtendedCloud/cron/cron.php
Configuration of API Access
|7. Now, we will show you how to configure a new product.|
Firstly, log in to your SolusVM admin area, go to 'Configuration' → 'API Access' and press 'Add API User'.
|8. Enter your current IP and once again click on 'Add API User' button.|
Configuration of Server
|9. Now, log in to your WHMCS admin area and go to 'Setup' → 'Products/Services' → 'Servers'. |
Afterwards, press 'Add New Server'.
|10. Enter your server name and IP address.
Choose 'SolusvmExtendedCloud' from a dropdown menu and press 'Save Changes'.
|11. After you configure your server correctly, you will see a following screen.|
Test your connection by pressing 'Test Connection'.
|12. Enter name, click on a previously created server and press 'Add'. |
Afterwards, confirm by pressing 'Save Changes'.
Configuration of Product
|13. In order to create and configure a product, click on 'Setup' → 'Products/Services' → 'Products/Services'. |
Press 'Create a New Group'.
|14. Enter a product group name and press 'Save Changes'.|
|15. When you have a product group, you can create your product and assign it to SolusVM Extended Cloud.|
To create a product click on 'Create a New Product'.
|16. Afterwards, choose a product type and product group from dropdown menus, enter your product name and press 'Continue'.|
|17. Now, go to 'Module Settings' section, choose both 'SolusvmExtendedCloud' and a previously created server group from dropdown menus.|
Afterwards, press 'Save Changes'.
|18. Select desired virtualization and press 'Save Changes'. |
All options of the selected virtualization will be loaded. Note that options availability differs according to a chosen virtualization!
|19. Now, fill out 'Product Configuration' section.
|20. Under 'Client Area Features' section you can define which features will be available for your clients.|
Feature is enabled when checkbox next to it has been marked.
Product With Dynamic Resources
|21. In order to set up a product with dynamic resources, press 'Generate Default' as shown on the following screen.|
Configurable options allow your clients to pick product with resources tailored to their needs.
Product With Static Resources
|22. You can also provide your clients with static resources.|
Simply, fill out the fields marked on the screen below with desired limits and press 'Save Changes'.
|23. Define resource range limits for new VPS.|
Set limits within which clients will be allowed to create their virtual machines. It will let you impose some borders on the created VPS.
|You have just finished the installation and configuration of the module!|
|SolusVM Extended Cloud For WHMCS is very simple and convenient in use. Your customers are only a few clicks away from creating their own servers.|
The module will allow your customers to manage multiple servers and freely change their resources. Everything within your own WHMCS client area.
|Now, let's check the interface of the module in the client area where you customers can create and manage virtual servers.|
Note: Screen below presents the module right after creation of the product. More features will be displayed after creating a server.
|You can manage each product from your WHMCS admin area.|
In addition to that, each VPS created by your clients can be easily monitored.
Management of Servers
|Let's start by creating a new virtual server. To do so, click on 'Create Virtual Server' button.|
|Set server resources and click on 'Add New Virtual Server' button.|
|As you can see on the screen below, virtual server has been successfully created.|
Now let's see how we can manage our new server. To proceed, click on 'Manage' button.
|One of the most interesting and useful options offered to the users is the upgrade.|
Upgrade allows your customers to request a change of virtual server resources.
|Set details of server upgrade and click on 'Upgrade' button.|
Upgrade is done automatically, no e-mail notifications or confirmation are sent.
|As you can see on the following screen, virtual server has been upgraded.|
|Right next to 'Upgrade' option, there are 'Graphs'. |
Press it to see generated statistics on 'Network Traffic', 'Load Average' and 'Memory Usage'.
|For more information about management of already created virtual server visit SolusVM Extended VPS For WHMCS Wiki|
Dynamic Server Resources Setup With Configurable Options
|If you want to allow your clients to dynamically set servers with resources they choose, follow these steps.|
Firstly, you should have a ready product. For more information on how to create one, head to 'Configuration of Product' instruction.
|If you decide to set pricing per server resource ordered, you can find instruction for it here.|
|If you prefer to charge your clients for server resources they actually use, you can use our Advanced Billing For WHMCS module.|
Management of DNS
|When you combine SolusVM Extended Cloud For WHMCS with DNS Manager For WHMCS, your clients will be able to manage PowerDNS zones and records from the client area.|
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.
|To connect both modules, go to 'Settings' → 'Packages' section of DNS Manager and add a new package.|
|Name the package and provide any details you find useful. Then proceed to 'Item' section.|
|Select SolusVM Extended Cloud from the list of products and click on 'Add' .|
|Your package should now appear on the list. To change its status click on the button as shown below.|
|Once done, you will see a proper note.|
|Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.|
|You can find 'Manage DNS' option also in the left menu.|
|Depending on previously chosen settings, your customers will be able to add and remove DNS zones.|
Management of Billing
|When you combine SolusVM Extended Cloud For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.|
Enable 'Usage Records' extension for Solus Cloud products.
|The module allows you to charge your customers basing on the server resources used by them. Set free limits and pricing for used records.|
|With Advanced Billing module, you can also display the current server resource usage and its cost for your customers.|
Management of Email Templates
|You can automatically send your customers emails with details of newly created virtual servers.|
To do so, create a new email template with 'Product' type and 'Unique Name' specified in SolusVM Documentation, in our case it is 'KVM Virtual Server'.
|You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use variables:
|SolusVM Extended Cloud is a very complex module. Therefore many things might go wrong.|
To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created 'Debug Mode'.
|Afterwards, go to 'Utilities' → 'Logs' → 'Module Log' and click on 'Enable Debug Logging' in order to enable it. The button should change its value to 'Disable Debug Logging'. |
From that moment, each action performed by the module will be recorded in the log.
|Remember to turn off Debug Mode after you fix the problem.|
|Underneath, you will find a short description of a real life example of managing and rotating between locations with SolusVM Extended Cloud For WHMCS.|
Take a quick look at it and note the flow.
|Let's assume that Mr Smith has one master server called 'Master'. This is the server Mr Smith configured and connects with from WHMCS with the help of our module.|
This server contains 3 slave servers configured in his SolusVM environment. These are:
These three slave servers are server nodes. In this configuration example, all of Mr Smith's clients order products on 'Master' server and so they receive resources available on server 1, 2, 3.
|1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore we paid special attention to displayed messages.|
Read carefully each message, follow the instructions and you shall have no problems using the module.
|2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time to process the request and execute the operation.|
|3. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.|
|Essential guidance through the process of updating the module is offered here.|
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
Update of Products
|Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.|
1. Go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedCloud' .
|1. When you have problems with connection, check whether your SELinux or firewall does not block ports.|
|2. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.|
Firstly, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.
|3. By default our module connects with SolusVM server on port 5353. If you are using different port, you need to specify it in 'Hostname' field.|
Default port for SSL connections is 5656. To connect on that port enter your hostname as follows: 'yourhostname.com:5656'. Keep in mind that you can connect on any port.