SolusVM Extended Cloud For WHMCS
Line 6: | Line 6: | ||
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended Cloud For WHMCS''' allows your customers to create and manage multiple virtual servers in your WHMCS client area.<br /> | |style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended Cloud For WHMCS''' allows your customers to create and manage multiple virtual servers in your WHMCS client area.<br /> | ||
Clients will be able to freely resize and upgrade their servers within resource limit defined by you.<br /> | Clients will be able to freely resize and upgrade their servers within resource limit defined by you.<br /> | ||
− | The module offers range of functionalities owing to which your clients will be | + | The module offers a range of functionalities owing to which your clients will be able to manage backups of flexible virtual servers as well as view graphs or access console. |
|} | |} | ||
<!-- fixed --> | <!-- fixed --> | ||
Line 147: | Line 147: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br /> | ||
− | Enter your license key between quotation marks as presented on the following screen. You can find your license key | + | 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' ''. |
|} | |} | ||
{| | {| | ||
Line 154: | Line 154: | ||
==Configuration of API Access== | ==Configuration of API Access== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''5. Now we will show you how to configure a new product.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''5. Now, we will show you how to configure a new product.'''<br /> |
− | Firstly, log in to your SolusVM admin area, go to '' ' | + | Firstly, log in to your SolusVM admin area, go to '' 'Configuration' '' → '' 'API Access' '' and press '' 'Add API User'.'' |
|} | |} | ||
{| | {| | ||
Line 169: | Line 169: | ||
==Configuration of Server== | ==Configuration of Server== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''7. Now log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''7. Now, log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.'''<br /> |
Afterwards, press '' 'Add New Server' ''. | Afterwards, press '' 'Add New Server' ''. | ||
|} | |} | ||
Line 177: | Line 177: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br /> | ||
− | + | *'''Username''' - fill in with API User ID | |
− | + | *'''Password''' - fill in with API User Key | |
+ | Choose '' 'SolusvmExtendedCloud' '' from a dropdown menu and press '' 'Save Changes' ''. | ||
|} | |} | ||
{| | {| | ||
Line 185: | Line 186: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''<br /> | ||
− | Test your connection through pressing '' 'Test Connection' ''. Now you need to create a new group for your server. For that purpose press '' 'Create New Group' ''. | + | Test your connection through pressing '' 'Test Connection' ''.,br /> |
+ | Now, you need to create a new group for your server. For that purpose press '' 'Create New Group' ''. | ||
|} | |} | ||
{| | {| | ||
Line 191: | Line 193: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on | + | |style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on a previously created server and press '' 'Add' ''.<br /> |
+ | Afterwards, confirm through pressing '' 'Save Changes' ''.''' | ||
|} | |} | ||
{| | {| | ||
Line 199: | Line 202: | ||
==Configuration of Product== | ==Configuration of Product== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure a product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br /> |
− | + | Click on '' 'Create a New Group' ''. | |
|} | |} | ||
{| | {| | ||
Line 206: | Line 209: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name | + | |style="padding: 0px 0px 20px 15px;"|'''12. Enter a product group name and press '' 'Save Changes' ''.''' |
|} | |} | ||
{| | {| | ||
Line 212: | Line 215: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''13. When you have a product group, you can create your product and assign it to SolusVM Extended Cloud. | + | |style="padding: 0px 0px 15px 15px;"|'''13. 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' ''. | To create a product click on '' 'Create a New Product' ''. | ||
|} | |} | ||
Line 219: | Line 222: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''14. Afterwards, choose | + | |style="padding: 0px 0px 20px 15px;"|'''14. Afterwards, choose a product type and product group from dropdown menus, enter your product name and press '' 'Continue' ''.''' |
|} | |} | ||
{| | {| | ||
Line 225: | Line 228: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''15. Now, go to | + | |style="padding: 0px 0px 15px 15px;"|'''15. Now, go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedCloud' '' and your previously created server group from dropdown menus.'''<br /> |
Afterwards, press '' 'Save Changes' ''. | Afterwards, press '' 'Save Changes' ''. | ||
|} | |} | ||
Line 240: | Line 243: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''17. Now, choose desired values from '' 'Node' '', '' 'Plan' '' and '' 'Internal IP' '' dropdown menus.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''17. Now, choose desired values from '' 'Node' '', '' 'Plan' '' and '' 'Internal IP' '' dropdown menus.'''<br /> | ||
− | Fill '' 'Username Prefix' '' field and scroll down to | + | Fill in '' 'Username Prefix' '' field and scroll down to '' 'Client Area Features' '' section. |
|} | |} | ||
{| | {| | ||
Line 246: | Line 249: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''18. | + | |style="padding: 0px 0px 15px 15px;"|'''18. Under '' 'Client Area Features' '' section you can define which features will be available for your clients.'''<br /> |
Feature is enabled by marking checkbox next to it.<br /> | Feature is enabled by marking checkbox next to it.<br /> | ||
'''Important 1:''' It is adviced to disable features which are not supported by chosen virtualization.<br /> | '''Important 1:''' It is adviced to disable features which are not supported by chosen virtualization.<br /> | ||
− | '''Important 2:''' Keep in mind that root password is generated automatically in KVM virtualization upon its creation and reset.<br /> | + | '''Important 2:''' Keep in mind that the root password is generated automatically in KVM virtualization upon its creation and reset.<br /> |
There is no possibility to set your own password due to SolusVM API limitations for KVM virtualization. | There is no possibility to set your own password due to SolusVM API limitations for KVM virtualization. | ||
|} | |} | ||
Line 256: | Line 259: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''18. Our module allows you to set up custom names for OS templates visible | + | |style="padding: 0px 0px 15px 15px;"|'''18. Our module allows you to set up custom names for OS templates visible on the client area.'''<br /> |
− | It can be done | + | It can be done in the '' 'Templates Friendly Name' '' section through filling fields next to OS templates you wish to rename.<br /> |
− | + | In the next section you can define which OS templates will be available for your clients by marking checkboxes next to them.<br /> | |
Now, press '' 'Save Changes' ''. | Now, press '' 'Save Changes' ''. | ||
|} | |} | ||
Line 267: | Line 270: | ||
==Product With Dynamic Resources== | ==Product With Dynamic Resources== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''19. In order to set up product with dynamic resources, | + | |style="padding: 10px 0px 15px 15px;"|'''19. In order to set up product with dynamic resources, press '' 'Generate Default' '' as shown on the following screen.'''<br /> |
− | Configurable options allow your | + | Configurable options allow your clients to pick product with resources tailored to theirs needs.<br /> |
Configurable options can be edited and each option can be priced. Follow to [http://www.docs.modulesgarden.com/SolusVM_Extended_Cloud#Dynamic_Server_Resources_Setup_With_Configurable_Options this] article for more information. | Configurable options can be edited and each option can be priced. Follow to [http://www.docs.modulesgarden.com/SolusVM_Extended_Cloud#Dynamic_Server_Resources_Setup_With_Configurable_Options this] article for more information. | ||
|} | |} | ||
Line 277: | Line 280: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|'''19. You can also provide your clients with static resources.'''<br /> | |style="padding: 10px 0px 15px 15px;"|'''19. You can also provide your clients with static resources.'''<br /> | ||
− | Simply, fill fields marked on the screen below with desired limits and press '' 'Save Changes' ''.<br /> | + | Simply, fill out fields marked on the screen below with desired limits and press '' 'Save Changes' ''.<br /> |
− | ''Note: Make sure that this product do not have assigned configurable options otherwise they will overwrite limits provided | + | ''Note: Make sure that this product do not have assigned configurable options otherwise they will overwrite limits provided in this step.'' |
|} | |} | ||
{| | {| | ||
Line 290: | Line 293: | ||
{| | {| | ||
|style="padding: 10px 0px 30px 0px;"|'''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.'''<br /> | |style="padding: 10px 0px 30px 0px;"|'''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.'''<br /> | ||
− | + | The module will allow your customers to manage multiple servers and freely change their resources. Everything within your own WHMCS client area.<br /> | |
Owing to integration with Advanced Billing For WHMCS you can even offer product, for which client will be billed depending on its usage.<br /> | Owing to integration with Advanced Billing For WHMCS you can even offer product, for which client will be billed depending on its usage.<br /> | ||
An additional possibility is also integration with DNS Manager For WHMCS allowing to manage PowerDNS zones and records. | An additional possibility is also integration with DNS Manager For WHMCS allowing to manage PowerDNS zones and records. | ||
Line 296: | Line 299: | ||
==Interface== | ==Interface== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Now, let's check the interface of the module in | + | |style="padding: 10px 0px 15px 15px;"|Now, let's check the interface of the module in the client area where you customers can create and manage virtual servers.<br /> |
''Note: Screen below presents the module, right after creation of the product. More features will show up after creating a server.'' | ''Note: Screen below presents the module, right after creation of the product. More features will show up after creating a server.'' | ||
|} | |} | ||
Line 331: | Line 334: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Module offers all the management functionalities | + | |style="padding: 0px 0px 15px 15px;"|Module offers all the management functionalities of SolusVM Extended For VPS with one significant difference, the upgrade.<br /> |
Upgrade allows your customers to request a change of virtual server resources.<br /> | Upgrade allows your customers to request a change of virtual server resources.<br /> | ||
For more information about management of already created virtual server visit [http://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Management_of_Server SolusVM Extended VPS For WHMCS Wiki] | For more information about management of already created virtual server visit [http://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Management_of_Server SolusVM Extended VPS For WHMCS Wiki] |
Revision as of 12:40, 17 December 2014
Contents |
About SolusVM Extended Cloud For WHMCS
SolusVM Extended Cloud For WHMCS allows your customers to create and manage multiple virtual servers in your WHMCS client area. Clients will be able to freely resize and upgrade their servers within resource limit defined by you. |
- Provisioning Module Functionality:
✔ Create Client |
✔ Suspend/Unsuspend Servers |
✔ Terminate Client And All His Servers |
✔ Dynamic Server Resources Setup With Configurable Options |
- Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Product |
✔ Get Server Status |
✔ Graphs: Traffic, Load, Memory |
✔ Configurable Client Area Features |
✔ OS Templates Allowed For Rebuild |
✔ Friendly Names For OS Templates |
✔ Possibility To Turn Off Root Password Storing In The System Database |
- Client Area Features:
✔ Create/Delete Server |
✔ Boot/Reboot/Shutdown/Rebuild Server |
✔ Upgrade Server |
✔ Enable TUN/TAP And PAE |
✔ Change Password: Root, Client, SSH Console And VNC Console |
✔ Change Boot Order |
✔ Get Server Status |
✔ Graphs: Traffic, Load, Memory |
✔ SSH Console (OpenVZ & Xen Virtualizations) |
✔ VNC Console (KVM & Xen HVM Virtualizations) |
✔ Control Panel Button |
✔ OS Templates Allowed For Rebuild |
✔ Friendly Names For OS Templates |
✔ Send Email Templates After Server Creation Based On Type |
- General Info:
✔ Integrated With DNS Manager For WHMCS - Supports PowerDNS (read more) |
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more) |
✔ Extended API Connection Test |
✔ Multi-Language Support |
✔ Supports WHMCS V5 and Later |
- Available Configurable Options:
✔ Memory Limit |
✔ Storage Limit |
✔ Bandwidth Limit |
✔ CPU Cores Limit |
✔ IP Addresses Limit |
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 your client area and download SolusVM Extended Cloud For WHMCS. |
2. Upload and extract the module into the main WHMCS directory. Files in your WHMCS directory should look like this. |
3. When you install SolusVM Extended Cloud 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' . |
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 in your client area → 'My Products' . |
Configuration of API Access
5. 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'. |
6. Enter your current IP and once again click on 'Add API User' button. |
Configuration of Server
7. Now, log in to your WHMCS admin area and go to 'Setup' → 'Products/Services' → 'Servers' . Afterwards, press 'Add New Server' . |
8. Enter your server name and IP address.
Choose 'SolusvmExtendedCloud' from a dropdown menu and press 'Save Changes' . |
9. After you configure your server correctly, you will see a following screen. Test your connection through pressing 'Test Connection' .,br /> Now, you need to create a new group for your server. For that purpose press 'Create New Group' . |
10. Enter name, click on a previously created server and press 'Add' . Afterwards, confirm through pressing 'Save Changes' . |
Configuration of Product
11. In order to create and configure a product, click on 'Setup' → 'Products/Services' → 'Products/Services' . Click on 'Create a New Group' . |
12. Enter a product group name and press 'Save Changes' . |
13. 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' . |
14. Afterwards, choose a product type and product group from dropdown menus, enter your product name and press 'Continue' . |
15. Now, go to 'Module Settings' section, choose both 'SolusvmExtendedCloud' and your previously created server group from dropdown menus. Afterwards, press 'Save Changes' . |
16. Select desired virtualization and press 'Save Changes' . All options for selected virtualization will be loaded. |
17. Now, choose desired values from 'Node' , 'Plan' and 'Internal IP' dropdown menus. Fill in 'Username Prefix' field and scroll down to 'Client Area Features' section. |
18. Under 'Client Area Features' section you can define which features will be available for your clients. Feature is enabled by marking checkbox next to it. |
18. Our module allows you to set up custom names for OS templates visible on the client area. It can be done in the 'Templates Friendly Name' section through filling fields next to OS templates you wish to rename. |
File:SC17 2.png |
Product With Dynamic Resources
19. In order to set up 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 theirs needs. |
Product With Static Resources
19. You can also provide your clients with static resources. Simply, fill out fields marked on the screen below with desired limits and press 'Save Changes' . |
You have just finished the installation and configuration of the module! |
Management
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. |
Interface
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 show up 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 details 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 can we manage our new server. To proceed, click on 'Manage' button. |
Module offers all the management functionalities of SolusVM Extended For VPS with one significant difference, the upgrade. Upgrade allows your customers to request a change of virtual server resources. |
Set details of server upgrade and click on 'Upgrade' button. |
As you can see on the following screen, virtual server has been upgraded. |
Dynamic Server Resources Setup With Configurable Options
If you want to allow your clients to dynamically set server 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 automatically generated configurable options do not seem to fill your client needs, you can edit them using this guide to change them. |
If you decide to set pricing per server resource ordered, you can find instruction how to proceed 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. |
Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below. |
Depending on a previously chosen settings, your customers will be able to add, edit and remove DNS zones and records. |
Module will also allow your customers to add, edit and remove Reverse DNS zones and records. |
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. Module allows you to charge your customers based on the server resources used by them. |
With Advanced Billing module, you can also display your customers the current server resource usage and their cost. |
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 the 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedCloud' . |
Debug Mode
SolusVM Extended Cloud is 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 a 'Debug Mode' . |
Afterwards, go to 'Utilities' → 'Logs' → 'Module Log' and click on 'Enable Debug Logging' in order to enable it. Button should change value for 'Disable Debug Logging' . From that moment, each action performed by module will be recorded in the log. |
Remember to turn off Debug Mode after you fix the problem. |
Tips
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 with using the module. |
2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time for processing the request and execution of operation. |
Common Problems
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 the '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. |