Personal tools
Namespaces

Variants
Actions

SolusVM Extended Cloud For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SolusVM Extended Cloud For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SolusVM Extended Cloud For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_reseller/features SolusVM Extended Cloud For WHMCS] =
+
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_cloud/features SolusVM Extended Cloud For WHMCS] =
 
{|
 
{|
 
|style="padding: 10px 0px 10px 0px;"|Opis!
 
|style="padding: 10px 0px 10px 0px;"|Opis!
Line 105: Line 105:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV$4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You will see a following screen. Let's proceed to configuration of your freshly installed module.
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now we will show you how to configure a new product.'''<br />
 +
First, log in to your SolusVM admin area, go to '' 'CONFIGURATION' '' → '' 'API Access' '' and add API User.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''8. Now we will show you how to configure a new product.'''
+
|style="padding: 0px 0px 20px 15px;"|'''6. Enter your current IP and once again click on '' 'Add API User' '' button.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|To do so log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' (or '' 'Setup' '' → '' 'Servers' '' in WHMCS v4.x).
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''7. Now log in to your WHMCS admin area. Press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 126: Line 130:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Next, enter your server name, IP address, username and password. Choose '' 'CpanelExtended' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br />
−
Keep in mind that values of client area buttons '' 'Login to Webmail' '' and '' 'Login to cPanel' '' are taken from a '' 'Hostname' '' field. If field is empty, they are taken from an '' 'IP Address' '' field.<br />
+
Next, enter your API User ID into '' 'Username' '' field and your API User Key into '' 'Password' '' field. Choose '' 'SolusvmExtendedCloud'' ' from a dropdown menu and press '' 'Save Changes' ''.<br />
−
Here you can also provide other server details like nameservers or maximum number of accounts.
+
Here you can also provide other server details like nameservers or maximum number of accounts.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''10. After you configure your server correctly, you will see a following screen.'''
+
|style="padding: 0px 0px 0px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
+
|style="padding: 0px 0px 20px 15px;"|Test your connection through pressing on '' 'Test Connection' ''. Now you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''12. In order to create and configure product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''
+
|style="padding: 0px 0px 0px 15px;"|'''11. In order to create and configure product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you don't have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 14.
+
|style="padding: 0px 0px 20px 15px;"|If you don't have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
 
|}
 
|}
 
{|
 
{|
Line 158: Line 162:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Enter product group name and press '' 'Create Group' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name, choose order form template and press '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''14. When you have a product group, you can create your product and assign it with cPanel Extended. If you already have a product, go to step 16.'''
+
|style="padding: 0px 0px 0px 15px;"|'''13. When you have a product group, you can create your product and assign it with SolusVM Extended Cloud. If you already have a product, go to step 15.'''
 
|}
 
|}
 
{|
 
{|
Line 170: Line 174:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV10.5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press '' 'Continue' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''16. Now go to '' 'Module Settings' '' section, choose both '' 'CpanelExtended' '' and your previously created server group from a dropdown menus and press'' 'Save Changes' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. Now go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedCloud' '' and your previously created server group from a dropdown menus.'''<br />
−
You can also configure your WHM Package here.
+
After you press '' 'Save Changes' '', all the configuration options will load below.<br />
 +
Generate configurable options and custom fields as shown on the following screen.<br />
 +
'''Keep in mind that without right custom fields, module will not work correctly.'''<br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''17. That's all. You have just correctly created and customized new product which will appear in cPanel Extended admin area.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Configuration of the product is divided into two sections: '' 'Features Setup' '' and '' 'Products Configuration' ''.<br />
−
To verify whether everything is working as it should click on '' 'Addons' '' → '' 'Cpanel Extended Functions' '' in your WHMCS. Afterwards click on '' 'Configure' '' button. 
+
In Features Setup you can select the functionalities you want to offer your customers.<br />
 +
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV12.5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''17. Custom fields generated by our module should contain 7 fields: '' 'vserverid' '', '' 'rootpassword' '', '' 'nodeid' '', '' 'vncip' '', '' 'vncport' '', '' 'vncpassword' '' and '' 'internalip' ''.'''<br />
 +
With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''You have just finished the installation and configuration of the module. From this moment your customers can start to place orders!
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 15px;"|
+
|style="padding: 10px 0px 30px 0px;"|'''SolusVM Extended Cloud For WHMCS offers very intuitive management of virtual servers.'''
 +
|}
 +
==Interface==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.<br />
 +
Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can monitor and manage each product from your WHMCS admin area.<br />
 +
Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV15.png]]
 +
|}
 +
 
 +
==Management of Server==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily boot (1), reboot (2), shutdown (3) and delete (4) their servers through pressing specified button.<br />
 +
Product allows also to quickly change hostname (5) and root password (6).
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|One of the most interesting functionality is a console where your clients can remotely manage server. To access it, simply press on the '' 'Console' '' button.<br />
 +
'''Currently module doesn't support SVN console for KVM. This feature will be added soon.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Rebuild feature allows to change template from available templates list. To rebuild your server click on '' 'Rebuild' '' button, choose template and click on the blue '' 'Rebuild' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV19.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Customers can quickly access the VPS Control Panel with just one click to '' 'Control Panel' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV18.png]]
 +
|}
 +
 
 +
==Debug Mode==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended Cloud is very complex module. Therefore many things might go wrong.<br />
 +
To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created a '' 'Debug Mode' ''.<br />
 +
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Afterwards go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Disable Debug Logging' '' in order to enable it.<br />
 +
From that moment, each action performed by module will be recorded in the log.<br />
 +
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br />
 +
If it doesn't, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.<br />
 +
The following screen presents exemplary module log.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV1.png]]
+
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|
+
|style="padding: 10px 0px 5px 15px;"|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.<br />
 +
Read carefully each message, follow the instructions and you shall have no problems with using the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|
+
|style="padding: 0px 0px 30px 15px;"|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=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 15px;"|
+
|style="padding: 10px 0px 0px 15px;"|1. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.<br />
 +
First, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.<br />
 +
'''In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.'''<br />
 +
Afterwards check your WHMCS server connection and products settings. If you are certain that everything is correct, use our [[#Debug Mode|Debug Mode]].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 5px 0px 0px 15px;"|
+
|style="padding: 5px 0px 30px 15px;"|2. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
 
|}
 
|}

Revision as of 09:41, 5 July 2013

Contents

About SolusVM Extended Cloud For WHMCS

Opis!
  • Client Area Management Includes:
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
  • Additional Functionality:
✔ Multi-Language Support
✔ Supports Advanced Billing For WHMCS (read more)
✔ Supports WHMCS Version V5 and Later

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.
SV1.png
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like this.
SV2.png
3. When you install SolusVM Extended Cloud for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/solusvmExtendedCloud/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
SV3.png
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.
Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .
SV4.png
5. Now we will show you how to configure a new product.

First, log in to your SolusVM admin area, go to 'CONFIGURATION' → 'API Access' and add API User.

SV5.png
6. Enter your current IP and once again click on 'Add API User' button.
SV6.png
7. Now log in to your WHMCS admin area. Press 'Setup' → 'Products/Services' → 'Servers' .
Afterwards press 'Add New Server' .
CP8.png
8. Enter your server name and IP address.

Next, enter your API User ID into 'Username' field and your API User Key into 'Password' field. Choose 'SolusvmExtendedCloud ' from a dropdown menu and press 'Save Changes' .
Here you can also provide other server details like nameservers or maximum number of accounts.

SV7.png
9. After you configure your server correctly, you will see a following screen.
Test your connection through pressing on 'Test Connection' . Now you need to create a new group for your server. For that purpose press 'Create New Group' .
SV8.png
10. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
SV9.png
11. In order to create and configure product click on 'Setup' → 'Products/Services' → 'Products/Services' .
If you don't have a product group, click on 'Create a New Group' . If you do, simply go to step 13.
CP12.png
12. Enter product group name, choose order form template and press 'Save Changes' .
SV10.png
13. When you have a product group, you can create your product and assign it with SolusVM Extended Cloud. If you already have a product, go to step 15.
To create a product click on 'Create a New Product' .
SV10.5.png
14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .
SV11.png
15. Now go to 'Module Settings' section, choose both 'SolusvmExtendedCloud' and your previously created server group from a dropdown menus.

After you press 'Save Changes' , all the configuration options will load below.
Generate configurable options and custom fields as shown on the following screen.
Keep in mind that without right custom fields, module will not work correctly.

SV12.png
16. Configuration of the product is divided into two sections: 'Features Setup' and 'Products Configuration' .

In Features Setup you can select the functionalities you want to offer your customers.
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.

File:SV12.5.png
17. Custom fields generated by our module should contain 7 fields: 'vserverid' , 'rootpassword' , 'nodeid' , 'vncip' , 'vncport' , 'vncpassword' and 'internalip' .

With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:

SV13.png
You have just finished the installation and configuration of the module. From this moment your customers can start to place orders!

Management

SolusVM Extended Cloud For WHMCS offers very intuitive management of virtual servers.

Interface

Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV14.png
You can monitor and manage each product from your WHMCS admin area.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV15.png

Management of Server

Module allows your customers to easily boot (1), reboot (2), shutdown (3) and delete (4) their servers through pressing specified button.

Product allows also to quickly change hostname (5) and root password (6).

SV16.png
One of the most interesting functionality is a console where your clients can remotely manage server. To access it, simply press on the 'Console' button.

Currently module doesn't support SVN console for KVM. This feature will be added soon.

SV17.png
Rebuild feature allows to change template from available templates list. To rebuild your server click on 'Rebuild' button, choose template and click on the blue 'Rebuild' button.
File:SV19.png
Customers can quickly access the VPS Control Panel with just one click to 'Control Panel' button.
SV18.png

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' .
To enable it, go to 'Module Settings' of your product and tick 'Debug Mode' as shown on the screen below.

SV20.png
Afterwards go to 'Utilities' → 'Logs' → 'Module Log' and click on 'Disable Debug Logging' in order to enable it.

From that moment, each action performed by module will be recorded in the log.
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.
If it doesn't, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.
The following screen presents exemplary module log.

SV21.png
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. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.

First, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.
In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.
Afterwards check your WHMCS server connection and products settings. If you are certain that everything is correct, use our Debug Mode.

2. 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=SolusVM_Extended_Cloud_For_WHMCS&oldid=4259"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SolusVM Extended Cloud For WHMCS