Personal tools
Namespaces

Variants
Actions

SolusVM Extended Cloud For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Management of Billing)
(Management of Billing)
Line 308: Line 308:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:SVC23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVC23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SVC25.png]]
 
|}
 
|}
  

Revision as of 14:29, 26 August 2013

Contents

About SolusVM Extended Cloud For WHMCS

SolusVM Extended Cloud For WHMCS allows your customers to create and manage their own virtual servers from your WHMCS client area.

Module offers range of functionalities owing to which your clients will be able to e.g. create, resize, reboot or upgrade virtual servers according to their needs.

  • Provisioning Module Functionality:
✔ Create Client
✔ Suspend/Unsuspend Servers
✔ Terminate Client And All His Servers
✔ Dynamic Server Resources Setup With Configurable Options
  • Features Included:
✔ Create Server
✔ Terminate Server
✔ Rebuild Server
✔ Resize Server
✔ Upgrade/Downgrade Server And Resources
✔ Boot/Reboot/Shutdown 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
✔ VNC Console
✔ Control Panel Button
✔ Possibility To Turn Off Root Password Storing In The System Database
  • Additional Functionality:
✔ Combined With DNS Manager For WHMCS - Supports PowerDNS (read more)
✔ Combined With Advanced Billing For WHMCS Module - Supports Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports WHMCS 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.
File:SVC1.png
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like this.
File:SVC2.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' .
File:SVC3.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' .
File:SVC4.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.

File:SVC7.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' .
File:SVC8.png
10. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
File:SVC9.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' .
File:SVC11.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 as shown on the following screen.

File:SVC12.png
16. Configuration of the product is divided into two sections: 'Features Setup' and 'Product 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, and set server resources limit for the product.

File:SVC12.5.png
17. With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:
File:SVC13.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 is very simple and convenient in use. Your customers are only a few clicks away from creating their own servers.

Interface

Now let's check the interface of the module in your WHMCS client area where you customers can create and manage virtual servers.

Note that the screen below presents the module, right after creation of the product. More features will show up after creating a server.

File:SVC14.png
You can monitor and manage each product from your WHMCS admin area.
File:SVC15.png

Management of Servers

Let's start from creating new virtual server. To do so, click on 'Create Virtual Server' button.
File:SVC16.png
Set server's details and click on 'Add New Virtual Server' button.
File:SVC17.png
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.

File:SVC18.png
Module offers all the management functionalities as SolusVM Extended For VPS with one significant difference, the upgrade.

Upgrade allows your customers to request a change of virtual server resources.
For more information about management of already created virtual server visit SolusVM Extended VPS For WHMCS Wiki

File:SVC19.png
Set upgrade's details and click on 'Upgrade' button.
File:SVC20.png
As you can see on the following screen, virtual server has been upgraded.
File:SVC21.png

Management of DNS

When you combine SolusVM Extended Cloud For WHMCS With DNS Manager For WHMCS, your clients will be able to manage PowerDNS 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 'Processing' section of DNS Manager, configure the module, tick 'With Products' and choose SolusVM Extended Cloud product.

File:SVC24.png
To provide a DNS management in the client area simply use this address 'your_whmcs_url/clientarea.php?managedns' . Replace 'your_whmcs_url' with address of your whmcs directory.

Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.

SV24.png
Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
File:SV25.png

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.

File:SVC23.png
With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
File:SVC25.png

Update of Products

Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.

Firstly, go to 'Setup' 'Products/Services' 'Products/Services' 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedCloud' .
Afterwards go to 'Setup' 'Products/Services' 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedCloud' .
Once again go to 'Setup' 'Products/Services' 'Products/Services' 'Module Settings' of your product and make sure that 'Server Group' is set up correctly.
In the last step generate default configurable options and custom fields through clickng on 'Generate default' buttons. Your SolusVM Extended Cloud product is ready to use!

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.

File:SVC22.png
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.
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. 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.
Field below 'Tick to use SSL Mode for Connections' switches connection type between http and https. Note that this is something different from choosing the port to connect.

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

3. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SolusVM Extended Cloud For WHMCS