Personal tools
Namespaces

Variants
Actions

SolusVM Extended VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Dynamic Server Resources Setup With Configurable Options)
(→‎Upgrade Guide)
 
(148 intermediate revisions by 11 users not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SolusVM Extended VPS For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SolusVM Extended VPS For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS For WHMCS] =
+
=About [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps SolusVM Extended VPS For WHMCS] =
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended VPS For WHMCS''' allows you to automatically provision virtual servers to your clients.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended VPS For WHMCS''' will allow you to automatically provision and manage virtual servers in your WHMCS.<br/>
−
Owing to well-thought module configuration, you will be able to quickly and capably set up ready products in WHMCS and offer them to your customers.<br />
+
You will be able to set up ready products in your system through the use of various configurable options.<br/>
−
Module lets your clients to conveniently manage virtual servers from your own WHMCS client area. Everything in an easy and enjoyable way.
+
Your clients will be able to perform all crucial actions on their servers remotely, access different consoles, view graphs and more.
 
|}
 
|}
−
*'''Features Included:'''
+
<!-- fixed -->
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Provisioning Module
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Virtual Server Management From The Client Area
+
|style="padding: 0px 0px 0px 30px;"|✔ Create User Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Complete Product Management From The Admin Area
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Package - Supports Configurable Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Simple Installation
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password Of Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Dynamic Server Resources Setup With Configurable Options
+
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
 
|}
 
|}
−
*'''Admin Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle TUN/TAP And PAE
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Reconfigure Network
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Suspend/Unsuspend Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, SSH Console, VNC Console
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade/Downgrade Server And Resources
+
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable TUN/TAP And PAE
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, SSH Console And VNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
+
|style="padding: 0px 0px 0px 30px;"|✔ Change IP Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Product Resource:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Get Server Status
+
|style="padding: 0px 0px 0px 45px;"|✔ Dynamically - Using Configurable Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Graphs: Traffic, Load, Memory
+
|style="padding: 0px 0px 0px 45px;"|✔ Statically - Using 'Module Settings' Fields
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configurable Client Area Features
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ OS Templates Allowed For Rebuild
+
|style="padding: 0px 0px 0px 30px;"|✔ Define OS Templates Available For Rebuild
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Friendly Names For OS Templates
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow To Rebuild Server On Purchased OS Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Possibility To Create New User For Each VPS Ordered By Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Rebuild Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Possibility To Turn Off Root Password Storing In The System Database
+
|style="padding: 0px 0px 0px 30px;"|✔ Select Kernels For Rescue Mode
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Friendly Names For OS Templates And Nodes
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create New SolusVM User For Each VPS Ordered By Client
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Storing In System Database
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Change After Server Creation
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Decoded Server Password
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Run API Connection Test
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown/Delete Server
+
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details And Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown/Rebuild/Delete Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ SSH Console (OpenVZ & Xen Virtualizations)
+
|style="padding: 0px 0px 0px 30px;"|✔ Access SSH Console - OpenVZ And Xen Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console (KVM & Xen HVM Virtualizations)
+
|style="padding: 0px 0px 0px 30px;"|✔ Access VNC Console - KVM And Xen HVM Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Control Panel Button
+
|style="padding: 0px 0px 0px 30px;"|✔ Access NoVNC HTML5 Console - KVM And Xen HVM Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable TUN/TAP And PAE
+
|style="padding: 0px 0px 0px 30px;"|✔ Access HTML5 Serial Console - OpenVZ And Xen Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, SSH Console And VNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Hostname
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle TUN/TAP And PAE
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle PXE (Preboot Execution Environment)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Rescue Mode With Chosen Kernel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Get Server Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Reconfigure Network
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Graphs: Traffic, Load, Memory
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Passwords: Root, Client, SSH Console And VNC Console
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Templates After Server Creation Based On Type
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Hostname
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Two Layouts
+
|style="padding: 0px 0px 0px 30px;"|✔ Change IP Addresses
 
|}
 
|}
−
*'''Additional Functionality:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Supports PowerDNS [http://www.modulesgarden.com/products/whmcs/dns_manager/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Extended API Connection Test
+
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Templates After Creation Of Server Based On Its Type
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V5 and Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
 
|}
 
|}
−
 
+
{|
−
*'''Available Configurable Options:'''
+
|style="padding: 0px 0px 10px 30px;"|✔ Choose SolusVM Username When Ordering New Product
 +
|}
 +
*'''Configurable Options:'''
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Operating System
 
|style="padding: 10px 0px 0px 30px;"|✔ Operating System
Line 145: Line 164:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Disk Space
 
|style="padding: 0px 0px 0px 30px;"|✔ Disk Space
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Secondary Disk Size
 
|}
 
|}
 
{|
 
{|
Line 153: Line 175:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Extra IP Address
+
|style="padding: 0px 0px 0px 30px;"|✔ Extra IPv4 Address
 
|}
 
|}
 
{|
 
{|
Line 159: Line 181:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Location
+
|style="padding: 0px 0px 0px 30px;"|✔ Location
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ ISO Image
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Network Speed
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Rebuild Limit
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Supports OpenVZ, Xen And KVM Virtualization
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Supports PowerDNS [https://www.modulesgarden.com/products/whmcs/dns-manager/features (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing/features (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Complete Management of IP Pools [https://www.modulesgarden.com/products/whmcs/ip-manager/features (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Most Suitable Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports SolusVM 1.0 (Compatibility With SolusVM 2 Coming Soon)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 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/solusvm-extended-vps#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install SolusVM Extended VPS For WHMCS.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''In this tutorial we will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps SolusVM Extended VPS For WHMCS.]'''<br/>
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download SolusVM Extended VPS For WHMCS.'''
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
Line 174: Line 243:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
Files in your WHMCS directory should look like on the following screen.
+
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>  
 +
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to 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 any more. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install SolusVM Extended VPS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM Extended VPS For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
−
File is located at '' 'modules/servers/solusvmExtendedCloud/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
File is located in '' 'modules/servers/solusvmExtendedVPS/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
Line 188: Line 275:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''5. 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 at your client area → '' 'My Products' ''.
+
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'.''
 
|}
 
|}
 
{|
 
{|
Line 196: Line 283:
 
==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;"|'''6. 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.
+
Firstly, log in to your SolusVM admin area, go to '' 'Configuration' → 'API Access' '' and press  '' 'Add API User'.''
 
|}
 
|}
 
{|
 
{|
Line 203: Line 290:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''6. Enter your current IP and once again click on '' 'Add API User' '' button.'''
+
|style="padding: 0px 0px 20px 15px;"|'''7. Fill in your IP address and once again click on '' 'Add API User' '' button.'''
 
|}
 
|}
 
{|
 
{|
Line 210: Line 297:
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''7. Now log in to your WHMCS admin area. Press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''8. Now, log in to your WHMCS admin area and proceed to '' 'System Settings' → 'Servers'.'''''<br/>
−
Afterwards, press '' 'Add New Server' ''.
+
Afterwards, press '' 'Add New Server'.''
 
|}
 
|}
 
{|
 
{|
Line 217: Line 304:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''9. Enter your server name and IP address.'''<br/>
−
Next, enter your API User ID into '' 'Username' '' field and your API User Key into '' 'Password' '' field.<br />
+
Choose '' 'SolusvmExtendedVPS' '' from a dropdown menu and provide:
−
Choose '' 'SolusvmExtendedVPS' '' from a dropdown menu and press '' 'Save Changes' ''.<br />
+
*'''Username''' - fill in with API User ID
−
Here you can also provide other server details like nameservers or maximum number of accounts.  
+
*'''Password''' - fill in with API User Key
 +
Check if your server use SSL connection and optionally provide a custom port (by defualt the '' '5656' '' is used). <br/>
 +
Press '' 'Save Changes' '' when ready.
 
|}
 
|}
 
{|
 
{|
Line 226: Line 315:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''10. After configuring your server correctly, you are going to see the following screen.'''<br/>
−
Test your connection and API key through pressing on '' 'Test Connection' ''. <br />
+
Test your connection and API key through pressing '' 'Test Connection'.''<br/>
−
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
+
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.''
 
|}
 
|}
 
{|
 
{|
Line 234: Line 323:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then click on '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''11. Fill in name, choose a previously created server and press '' 'Add'.'' '''<br/>
 +
Confirm by clicking on '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
Line 242: Line 332:
 
==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;"|'''12. In order to create and configure product, go to '' 'System Settings' → 'Products/Services'.'''''<br/>
−
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to the step 13.
+
Afterwards, click on '' 'Create a New Group'. ''
 
|}
 
|}
 
{|
 
{|
Line 249: Line 339:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''13. Fill in a product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 255: Line 345:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. When you have a product group, you can create your product and assign it with SolusVM Extended VPS. If you already have a product, go to the step 15.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product and assign it to SolusVM Extended VPS.'''<br/>
−
To create a product click on '' 'Create a New Product' ''.
+
To create a product click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
Line 262: Line 352:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''15. Afterwards, choose your product type and product group from dropdown menus, fill in your product name and press '' 'Continue'.'''''
 
|}
 
|}
 
{|
 
{|
Line 268: Line 358:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and a previously created server group from dropdown menus.'''<br/>
−
Afterwards, press '' 'Save Changes' ''.
+
Afterwards, press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
Line 275: Line 365:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Start configuration of a product from '' 'Product Configuration' '' section.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''17. Start configuration of a product with '' 'Product Configuration' '' section.<br/>
−
Select desired '' 'Virtualization Type' '' and press '' 'Save Changes' '' in order to load options bounded to chosen virtualization.
+
Select desired '' 'Virtualization Type' '' and press '' 'Save Changes' '' in order to load the virtualization.
 
|}
 
|}
 
{|
 
{|
Line 282: Line 372:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''17. Now, choose '' 'Default Node' '', '' 'Plan' '', '' 'Default Operating System' '', '' 'Amount of IP' '' and '' 'Default Node Group' ''.
+
|style="padding: 0px 0px 15px 15px;"|'''18. Now, choose '' 'Default Node', 'Plan', 'Default Operating System', 'Number of IPs' '' and '' 'Default Node Group'.''<br/>
 +
''Note: default data will be used if no configurable options are generated!''
 
|}
 
|}
 
{|
 
{|
Line 288: Line 379:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''18. Define features available at the client area through marking/unmarking them at the '' 'Client Area Features' '' section.'''
+
|style="padding: 0px 0px 15px 15px;"|'''19. Define features available in the client area through marking/unmarking them under '' 'Client Area Features' '' section.'''<br/>
 +
'''Important:''' Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.<br/>
 +
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.
 
|}
 
|}
 
{|
 
{|
Line 294: Line 387:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. At the '' 'Templates Friendly Name' '' section you can set up custom names for templates.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''20. At the very bottom you may change available nodes names to any friendly name.'''
−
OS templates will be displayed at the client area under those names.<br />
+
 
−
Next section allows you to define which of OS templates will be available for your clients to rebuild their virtual servers.<br />
+
−
Confirm settings through pressing '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
Line 303: Line 394:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Final step is generating default configurable options.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''21. The final step is generating default configurable options.'''<br/>
−
To do so, press '' 'Generate Default' '' near '' 'Configurable Options' '' as shown on the screen below.
+
To do so, press '' 'Generate Default' '' near '' 'Configurable Options' '' as shown on the screen below.<br/>
 +
Any time you wish to refresh the list of your OS Templates and ISO Images press '' 'Synchronize' '' button marked on the following screen with a red arrow.<br/>
 +
''Note 1: You can set up user friendly names for the templates through editing configurable option group assigned to the product.''<br/>
 +
''Note 2: If you remove OS template or ISO image from the configurable option, it will be restored during synchronization.''
 
|}
 
|}
 
{|
 
{|
Line 310: Line 404:
 
|}
 
|}
 
{|
 
{|
−
|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!  
+
|style="padding: 0px 0px 30px 15px;"|'''You have just finished the installation and configuration of the module!
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers both for your admin and clients.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers both for your admins and clients.'''<br/>
−
In addition to that, it provides you with ability to offer your clients VPS tailored to their needs.<br />
+
In addition, it provides you with the ability to offer your clients VPS tailored to their needs.<br/>
−
Owing to integration with Advanced Billing For WHMCS you can even offer product, for which client will be billed depending of its usage.<br />
+
Owing to the integration with Advanced Billing For WHMCS you can even offer a product, which client will be billed for depending on its usage.
−
An additional possibility is also integration with DNS Manager For WHMCS allowing to manage PowerDNS  zones and records.
+
 
 
|}
 
|}
 
==Interface==
 
==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 />
+
|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: List of available features depends of selected virtualization.''<br />
+
''Note: List of available features depends on the selected virtualization.''<br/>
−
''Due to that, you have to manually disable features from the client area which are not supported by chosen virtualization.''
+
''Due to that, you have to manually disable features from the client area which are not supported by the selected virtualization.''
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SV18.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:SV18.png]]
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|The above screen presents a '' 'Classic Design' '' introduced in version 1.2. A following screen shows basic design.<br />
 
−
You can switch between designs by ticking '' 'Classic Design' '' at the '' 'Module Settings' '' → '' 'Client Area Features' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV19.png]]
 
 
|}
 
|}
 
{|
 
{|
Line 345: Line 432:
 
==Management of Server==
 
==Management of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily log into control panel (1), access SSH/VNC console (2), boot, reboot (3), shutdown (4), rebuild (5) and delete (6)  their VPSes.<br />
+
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily manage your server:  boot, reboot, shutdown, access SSH/VNC/HTML5 console, enable/disable PAE and PXE or reconfigure network.<br/> Additionally, you can log into control panel, rebuild servers and view usage graphs.<br/>
−
In an addition to that, your clients can change hostname (7) and root password (8), set up boot order (9), mount ISO (10) and unmount ISO (11).<br />
+
In addition to that, your clients can change hostname and root password.<br/>
−
Your clients can also easily enable/disable  PAE (13), view current resource usage and graphs of servers resource usage.<br />
+
Depending on the chosen virtualization type and selected in '' 'Module Settings' '' options, module allows your customers to mount/unmount ISO and enable/disable TUN/TAP.<br/>
−
Dependant on the chosen virtualization type, module allows your customers to enable/disable TUN/TAP (12).
+
'''Important:''' Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.<br/>
 +
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.
 
|}
 
|}
 
{|
 
{|
Line 354: Line 442:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|One of the most interesting functionality is SSH console where your clients can remotely manage server. To access it, simply press on the '' 'Console' '' button.<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, a VPS of KVM type is different than OpenVZ type.<br/>
−
''Note: This type of console is available only for OpenVZ & Xen virtualizations.''
+
The most noticeable difference is noVNC Console near Console button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SV21_1.png]]
 
|}
 
|}
 +
===SSH Console===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The module also enables remote access to VNC console.<br />
+
|style="padding: 10px 0px 15px 15px;"|It's one of the most interesting functionalities is SSH console, where your clients can remotely manage the server. To access it, simply press '' 'Console' '' button.<br/>
−
''Note: VNC console is used by KVM and Xen HVM virtualizations.''
+
''Note: This type of console is available only for OpenVZ & Xen virtualization.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SV22.png]]
 
|}
 
|}
 +
 +
===VNC Console===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Rebuild feature allows to change OS template from available OS templates list.<br />
+
|style="padding: 10px 0px 15px 15px;"|The module also enables remote access to VNC console.<br/>
−
To rebuild your server click on '' 'Rebuild' '' button, choose template and click on the blue '' 'Rebuild' '' button.
+
''Note: VNC console is used by KVM and Xen HVM virtualization.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV23.png]]
 +
|}
 +
===HTML5 noVNC Console===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The module also enables usage of HTML5 noVNC console.<br/>
 +
''Note: noVNC console is used by KVM and Xen HVM virtualization.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV23_1.png]]
 +
|}
 +
===HTML 5 Serial Console===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|And the last supported console is HTML 5 serial console. <br/>
 +
 
 +
Please be informed that the installation of some dependencies is mandatory within your SoulsVM instance, in order to use the console.<br/>
 +
<b>Here is the [https://documentation.solusvm.com/display/DOCS/HTML+5+Serial+Console official SoulsVM documentation] regarding the installation of dependencies.</b><br/><br/>
 +
 
 +
''Note: HTML 5 Serial Console is used by OpenVZ and Xen virtualization.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV23_2.png]]
 +
|}
 +
 
 +
===Rebuild===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Rebuild feature allows you to change OS template from available OS templates list.<br/>
 +
To rebuild your server click on '' 'Rebuild' '' button, choose template and confirm by pressing'' 'Rebuild' '' button.
 
|}
 
|}
 
{|
 
{|
Line 375: Line 495:
 
|}
 
|}
  
−
==Management of Email Templates==
+
===Graphs===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Move to '' 'Graphs' '' section. You will find there visualizations of your current '' 'Network Traffic', 'Load Average' '' and '' 'Memory Usage'.''<br/>
 +
Tracking your VPS usage you avoid sudden and unexpected overload.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV21_2.png]]
 +
|}
 +
===Rescue Mode (KVM Only)===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|One of the options available is Rescue Mode that may be turned on/off by the client. It allows to boot the server directly into the rescue mode.<br/>
 +
Press to enable this functionality.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV21_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|A pop up window appears, select a kernel from the list of available and enable it. SSH details will be viewed immediately.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV21_4.png]]
 +
|}
  
 +
==Management of Email Templates==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can automatically send your customers the emails with details of newly created virtual servers.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can automatically send your customers emails with details of newly created virtual servers.<br/>
−
To do so, create new email template with '' 'Product' '' type and '' 'Unique Name' '' specified in [http://docs.solusvm.com/v2/Default.htm#Modules/Billing/WHMCS/Email-Templates.htm SolusVM Documentation], in our case it is '' 'KVM Virtual Server' ''.<br />
+
To do so, create a new email template with '' 'Product' '' type and '' 'Unique Name' '' specified in [https://documentation.solusvm.com/display/DOCS/Email+Templates SolusVM Documentation], in our case it is '' 'KVM Virtual Server'.''<br/>
−
'''Use of other template unique names than specified in above documentation makes impossible to send emails.'''<br />
+
'''Usage of unique names other than specified in the above documentation makes it impossible to send emails.'''<br/>
 
''Note: The only supported email template unique names are: 'OpenVZ Virtual Server', 'Xen PV Virtual Server', 'Xen HVM' and 'KVM Virtual Server'.''
 
''Note: The only supported email template unique names are: 'OpenVZ Virtual Server', 'Xen PV Virtual Server', 'Xen HVM' and 'KVM Virtual Server'.''
 
|}
 
|}
Line 387: Line 529:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use these 4 variables:<br />
+
|style="padding: 0px 0px 15px 15px;"|You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use variables:
−
{$service_custom_field_rootpassword}, {$service_custom_field_vncip}, {$service_custom_field_vncport} and {$service_custom_field_vncpassword}.
+
*{$service_custom_field_rootpassword}
 +
*{$service_custom_field_vncip}
 +
*{$service_custom_field_vncport}
 +
*{$service_custom_field_vncpassword}.
 
|}
 
|}
 
{|
 
{|
Line 396: Line 541:
 
==Management of Custom Hooks==
 
==Management of Custom Hooks==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you have to do is to create some functions using PHP programming language.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you need is knowledge of PHP programming language.<br/>
−
Here you can see possible hooks:<br />
+
Possible hooks are:
−
solusvmExtendedVPS_customclientarea($params)
+
*solusvmExtendedVPS_customclientarea($params)
−
solusvmExtendedVPS_hostname($params)
+
*solusvmExtendedVPS_hostname($params)
−
solusvmExtendedVPS_username($params)
+
*solusvmExtendedVPS_username($params)
−
solusvmExtendedVPS_AdminLink($params)
+
*solusvmExtendedVPS_AdminLink($params)
−
solusvmExtendedVPS_create_one($params)
+
*solusvmExtendedVPS_create_one($params)
−
solusvmExtendedVPS_create_two($params)
+
*solusvmExtendedVPS_create_two($params)
−
solusvmExtendedVPS_create_three($params)
+
*solusvmExtendedVPS_create_three($params)
−
solusvmExtendedVPS_create_four($params)
+
*solusvmExtendedVPS_create_four($params)
−
solusvmExtendedVPS_create_five($params)
+
*solusvmExtendedVPS_create_five($params)
−
solusvmExtendedVPS_terminate_pre($params)
+
*solusvmExtendedVPS_terminate_pre($params)
−
solusvmExtendedVPS_terminate_post_success($params)
+
*solusvmExtendedVPS_terminate_post_success($params)
−
solusvmExtendedVPS_terminate_post_error($params)
+
*solusvmExtendedVPS_terminate_post_error($params)
−
solusvmExtendedVPS_suspend_pre($params)
+
*solusvmExtendedVPS_suspend_pre($params)
−
solusvmExtendedVPS_suspend_post_success($params)
+
*solusvmExtendedVPS_suspend_post_success($params)
−
solusvmExtendedVPS_suspend_post_error($params)
+
*solusvmExtendedVPS_suspend_post_error($params)
−
solusvmExtendedVPS_unsuspend_pre($params)
+
*solusvmExtendedVPS_unsuspend_pre($params)
−
solusvmExtendedVPS_unsuspend_post_success($params)
+
*solusvmExtendedVPS_unsuspend_post_success($params)
−
solusvmExtendedVPS_unsuspend_post_error($params)
+
*solusvmExtendedVPS_unsuspend_post_error($params)
−
solusvmExtendedVPS_changepackage_pre($params)
+
*solusvmExtendedVPS_changepackage_pre($params)
−
solusvmExtendedVPS_changepackage_post_success($params)
+
*solusvmExtendedVPS_changepackage_post_success($params)
−
solusvmExtendedVPS_changepackage_post_error($params)
+
*solusvmExtendedVPS_changepackage_post_error($params)
−
But before editing any of these hooks you have to rename file '' 'custom-rename.php' '' to '' 'custom.php' ''.
+
To enable these hooks, you have to rename file '' 'custom-rename.php' '' to '' 'custom.php'.''
 
|}
 
|}
 
{|
 
{|
Line 425: Line 570:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now your hooks are active, but they are empty, so they do nothing. To find details about hooks you need to read the file you previously edited.<br />
+
|style="padding: 0px 0px 15px 15px;"|Now your hooks are active, but since they are empty they do nothing. To find hooks' details, read a previously edited file.<br/>
−
In the mentioned file you will find the hook, information about its time of run, returned values and parameters.<br />
+
In the mentioned file you are going to find the hook, information about its time of run, returned values and parameters.<br/>
−
For example, if you have no domains but want to have hostname, you should set default value for hostname.<br />
+
For example, if you have no domains but want to have hostname, you should set default value for hostname.<br/>
−
To do so, find hook '' 'solusvmExtendedVPS_hostname($params)' '' and type '' 'return 'myhostname.com';' '' inside of it.<br />
+
To do so, find hook '' 'solusvmExtendedVPS_hostname($params)' '' and type '' 'return 'myhostname.com';' '' inside of it.<br/>
 
It should look like on the screen below:
 
It should look like on the screen below:
 
|}
 
|}
Line 437: Line 582:
 
==Dynamic Server Resources Setup With Configurable Options==
 
==Dynamic Server Resources Setup With Configurable Options==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If you want to allow your clients to dynamically set server with resources they choose, follow these steps.<br />
+
|style="padding: 10px 0px 15px 15px;"|If you wish to allow your clients to order servers with resources they choose, use configurable option group.<br/>
−
Firstly, you should have a ready product. For more information on how to create one, head to '' '[http://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Configuration_of_Product Configuration of Product]' '' instruction.<br />
+
To generate a configurable option group for a product, head to the 19th step of '' '[https://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Configuration_of_Product Configuration of Product]' '' instruction.<br />
−
The final result visible in the order form should be similar to the one presented on the screen below.
+
The final result visible in the order form should be similar to the one presented on the following screen.<br/>
 +
''Note: Field '' 'Username' '' appears only during ordering the first SolusVM VPS by client.''<br/>
 +
''In order to show that field, unmark '' 'One SolusVM User Per VPS For The Same Client' '' and mark '' 'Username When Ordering' '' checkbox.''
 
|}
 
|}
 
{|
 
{|
Line 445: Line 592:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not seem to fill your client needs, you can edit them using [http://www.docs.modulesgarden.com/How_To_Use_Configurable_Options#Editing_Configurable_Options this guide] to change them.
+
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not fulfill your clients' needs, you can edit them using [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options this guide].
 
|}
 
|}
 
{|
 
{|
Line 451: Line 598:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you decide to set pricing per server resource ordered, you can find instruction how to proceed [http://www.docs.modulesgarden.com/How_To_Use_Configurable_Options#Setting_Up_Pricing_For_Configurable_Options here].
+
|style="padding: 0px 0px 20px 15px;"|If you decide to set up pricing depending on the ordered resource, you can find instruction on how to proceed [https://www.docs.modulesgarden.com/General#Setting_Up_Pricing_For_Configurable_Options here].
 
|}
 
|}
 
{|
 
{|
Line 457: Line 604:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|If you prefer to charge your clients for server resources they actually use, you can use our [http://www.modulesgarden.com/products/whmcs/advanced_billing/features Advanced Billing For WHMCS] module.  
+
|style="padding: 0px 0px 30px 15px;"|If you prefer to charge your clients for server resources they actually use, you can use our [https://www.modulesgarden.com/products/whmcs/advanced-billing/features Advanced Billing For WHMCS] module.  
 
|}
 
|}
  
 
==Management of DNS==
 
==Management of DNS==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS With [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS DNS Manager For WHMCS], your clients will be able to manage PowerDNS from the client area.<br />
+
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS with  [https://www.docs.modulesgarden.com/index.php?title=DNS_Manager_For_WHMCS&oldid=19472 DNS Manager For WHMCS], your clients will be able to manage PowerDNS zones and records from the client area.<br/>
−
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.<br />
+
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.<br/>'' '''Important:''' SolusVM Extended VPS For WHMCS is compatible with DNS Manager For WHMCS V2.x.x.''
−
To connect both modules, go to '' 'Processing' '' section of DNS Manager, configure the module, tick '' 'With Products' '' and choose SolusVM Extended VPS product.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV26.png]]
+
|style="padding: 0px 0px 20px 15px;"|To connect both modules, go to '' 'Settings' → 'Packages' '' section of DNS Manager and add a new package.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, buttons '' 'Manage DNS' '' and '' 'Manage Reverse DNS' '' will appear in the client area as shown on the screen below.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV27.png]]
+
|style="padding: 0px 0px 20px 15px;"|Name the package and provide any details you find useful. Then proceed to '' 'Item' '' section.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_27_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV28.png]]
+
|style="padding: 0px 0px 20px 15px;"|Select SolusVM Extended VPS from the list of products and click on '' 'Add' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV29.png]]
+
|style="padding: 0px 0px 20px 15px;"|Your package should now appear on the list. To change its status click on the button as shown below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once done, you will see a proper note.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_30.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can find 'Manage DNS' option also in the left menu.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_30_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Depending on previously chosen settings, your customers will be able to add and remove DNS zones.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV2_31.png]]
 
|}
 
|}
  
 
==Management of Billing==
 
==Management of Billing==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
+
|style="padding: 10px 0px 20px 15px;"|When you combine SolusVM Extended VPS For WHMCS with [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS 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.
+
 
|}
 
|}
 
{|
 
{|
Line 497: Line 669:
 
|}
 
|}
 
{|
 
{|
−
|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 20px 15px;"|The module allows you to charge your customers basing on the server resources they use.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SV33.png]]
 
|}
 
|}
−
==Update of Products==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.<br />
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display the current server resource usage and their cost, as well as other allowed in Advanced Billing options that are on offer.
−
1. Go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and switch '' 'Module Name' '' from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS' ''.<br />
+
−
2. Proceed to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and switch your server type from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS' ''.<br />
+
−
3. Now, click the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and make sure that '' 'Server Group' '' is set up correctly.<br />
+
−
4. Last step is generating default configurable options and custom fields through clicking on '' 'Generate default' '' buttons.<br />
+
−
Your SolusVM Extended VPS product is ready to use!
+
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV34_1.png]]
 +
|}
 +
 
==Debug Mode==
 
==Debug Mode==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended VPS is very complex module. Therefore many things might go wrong.<br />
+
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended VPS is a 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 help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created '' 'Debug Mode'.''<br/>
 
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
 
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
 
|}
 
|}
Line 521: Line 691:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards go to the '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it. Button should change value for '' 'Disable Debug Logging' ''.<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterwards, go to '' 'Utilities' → 'Logs' → 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it.<br />
−
From that moment, each action performed by module will be recorded in the log.<br />
+
Now, each action performed by the module will be recorded in the module log.<br/>
−
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br />
+
In that way, you can easily check whether the 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 />
+
If not, it will indicate a problem with WHMCS product/server configuration or your SolusVM server.<br/>
−
The following screen presents exemplary module log.
+
The following screen presents an exemplary module log.
 
|}
 
|}
 
{|
 
{|
Line 532: Line 702:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
 
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
 +
|}
 +
==Importing Existing VPS==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|In this section, you can find short instruction on how to connect one of your clients to your already existing VPS in Solus panel. <br/> Take the following steps to make sure that the process will be carried out properly. <br/>
 +
1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the '' ' Add New Order' '' button. Next, select a '' 'Product/Service' '' and press '' 'Submit Order' ''. <br/> '''What is important, do not perform the '' 'Create' '' action.''' The status has to remain as '' 'Pending' ''. <br/> More info about placing orders can be found [https://docs.whmcs.com/Order_Management#Placing_an_Order here]<br/>
 +
2. Proceed to the newly created product's card in your admin area. Find the following custom fields:
 +
*'''vserverid'''
 +
*'''nodeid'''
 +
 +
The above-mentioned information has to be consistent with the data from your Solus panel. Now, complete these fields as presented below. <br/> '''Important!''' Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way. <br/> If you completed the required data, now change the status from '' 'Pending' '' to '' 'Active' '' and '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Photo_solus.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|3. If the completed data is correct, after refreshing the page, you will see the attached VPS from Solus. <br/> '''Important!'''  Remember to manually add other missing parameters of the VPS such as domains, credentials, IP Addresses, configurable options, SSH Key, billing cycle, etc. so they match the parameters of the attached VPS from Solus.
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|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 />
+
|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.
+
Read each message carefully, follow the instructions and you shall have no problems using the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 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.
+
|style="padding: 0px 0px 5px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. In the current version of SolusVM API there is no possibility to automatically upgrade Virtual Machine therefore you have to perform this action manually.<br />
+
|style="padding: 0px 0px 5px 15px;"|3. In the current version of SolusVM API there is no possibility to automatically upgrade Virtual Machine, therefore you have to perform this action manually.<br />
−
Upgrading package in the SolusVM VPS Extended module means upgrading of Solus Plan.
+
Upgrading package in the SolusVM VPS Extended module means upgrading Solus Plan.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|4. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|5. If you want a random hostname to be generated, enable the ''' 'Random Hostname' ''' option in the '' 'Admin Area Features' '' of the module settings.
 +
|}
 +
 
 +
=Update Instructions=
 +
{|
 +
|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.
 +
|}
 +
==Update of Products==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Our module is entirely compatible with [https://github.com/solusio/SolusVM-WHMCS-Module SolusVM WHMCS Module] ''(previously known as "SolusVM Pro")'' and you can easily upgrade your existing products without losing your settings.<br/>
 +
1. Go to '' 'System Settings' → 'Products/Services' → 'Module Settings' '' of your product and switch '' 'Module Name' '' from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS'.''<br/>
 +
2. Proceed to '' 'System Settings' → 'Servers' '' and switch your server type from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS'.''<br/>
 +
3. Now, click '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and make sure that '' 'Server Group' '' is set up correctly.<br/>
 +
4. The last step is generating default configurable options and custom fields through clicking on '' 'Generate default' '' button.<br/>
 +
Your SolusVM Extended VPS product is ready to use!
 +
|}
 +
=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/solusvm-extended-vps#open-source-version Open Source version] of your SolusVM Extended VPS 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.  
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|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.<br />
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
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.<br />
+
−
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.
+
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 5px 15px;"|2. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.<br />
 
|style="padding: 0px 0px 5px 15px;"|2. 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 />
+
Firstly, 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 />
 
'''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]].
+
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: 0px 0px 5px 15px;"|3. Your client get white page with '' '{"success":"1","status":"1"}' '' while entering '' 'Control Panel' ''.<br />
+
|style="padding: 0px 0px 5px 15px;"|3. Your client gets white page with '' '{"success":"1","status":"1"}' '' while entering '' 'Control Panel' ''.<br />
 
''Cause'': SolusVM client area template is based on Bootstrap, which may sometimes cause such errors.<br />
 
''Cause'': SolusVM client area template is based on Bootstrap, which may sometimes cause such errors.<br />
 
''Solution'': Switch template used by SolusVM client area.
 
''Solution'': Switch template used by SolusVM client area.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 5px 0px 30px 15px;"|4. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
+
|style="padding: 0px 0px 10px 15px;"|4. You have received the following error:
 +
Error 'Fatal error: Call to undefined function mime_content_type() in
 +
/your_whmcs/clients/modules/servers/solusvmExtendedVPS/solusvmExtendedVPS.php on line 0 '.
 +
''Reason:'' Function 'mime_content_type()' is disabled at your server. Our module uses it in order to detect MIME Content-type for a file.<br />
 +
''Solution:'' Enable function mime_content_type() in your PHP or ask your server provider to do so.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|5. 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.<br />
 +
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.<br />
 +
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.
 
|}
 
|}

Latest revision as of 13:07, 19 April 2024

Contents

[edit] About SolusVM Extended VPS For WHMCS

SolusVM Extended VPS For WHMCS will allow you to automatically provision and manage virtual servers in your WHMCS.

You will be able to set up ready products in your system through the use of various configurable options.
Your clients will be able to perform all crucial actions on their servers remotely, access different consoles, view graphs and more.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Create User Account
✔ Change Package - Supports Configurable Options
✔ Change Password Of Account
✔ Boot/Reboot/Shutdown Server
✔ Toggle TUN/TAP And PAE
✔ Reconfigure Network
✔ Rebuild Server
✔ Change Password: Root, Client, SSH Console, VNC Console
✔ Mount/Unmount ISO
✔ Change Boot Order
✔ View Server Status
✔ View Graphs: Traffic, Load, Memory
✔ Change IP Addresses
✔ Define Product Resource:
✔ Dynamically - Using Configurable Options
✔ Statically - Using 'Module Settings' Fields
✔ Configure Client Area Features Per Product
✔ Define OS Templates Available For Rebuild
✔ Allow To Rebuild Server On Purchased OS Only
✔ Set Rebuild Limit
✔ Select Kernels For Rescue Mode
✔ Configure Friendly Names For OS Templates And Nodes
✔ Create New SolusVM User For Each VPS Ordered By Client
✔ Toggle Root Password Storing In System Database
✔ Toggle Root Password Change After Server Creation
✔ View Decoded Server Password
✔ Run API Connection Test
  • Client Area Features:
✔ View Server Details And Status
✔ Boot/Reboot/Shutdown/Rebuild/Delete Server
✔ 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
✔ Toggle TUN/TAP And PAE
✔ Toggle PXE (Preboot Execution Environment)
✔ Toggle Rescue Mode With Chosen Kernel
✔ Reconfigure Network
✔ Change Passwords: Root, Client, SSH Console And VNC Console
✔ Change Hostname
✔ Change IP Addresses
✔ Mount/Unmount ISO
✔ Change Boot Order
✔ View Graphs: Traffic, Load, Memory
✔ Send Email Templates After Creation Of Server Based On Its Type
✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
✔ Choose SolusVM Username When Ordering New Product
  • Configurable Options:
✔ Operating System
✔ Memory
✔ Disk Space
✔ Secondary Disk Size
✔ Bandwidth
✔ CPU
✔ Extra IPv4 Address
✔ Control Panel
✔ Location
✔ ISO Image
✔ Network Speed
✔ Rebuild Limit
  • 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)
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Pools (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports SolusVM 1.0 (Compatibility With SolusVM 2 Coming Soon)
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.8 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

In this tutorial we will show you how to successfully install SolusVM Extended VPS 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.
SV1.png
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.

PHP72 74.png
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.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
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 any more. Find more info here.

PHP56 74.png
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.

SV2 1.png
4. When you install SolusVM Extended VPS For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/solusvmExtendedVPS/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

SV3.png
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'.

SV4.png

[edit] Configuration of API Access

6. 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'.

SV5.png
7. Fill in your IP address and once again click on 'Add API User' button.
SV6.png

[edit] Configuration of Server

8. Now, log in to your WHMCS admin area and proceed to 'System Settings' → 'Servers'.

Afterwards, press 'Add New Server'.

SV7.png
9. Enter your server name and IP address.

Choose 'SolusvmExtendedVPS' from a dropdown menu and provide:

  • Username - fill in with API User ID
  • Password - fill in with API User Key

Check if your server use SSL connection and optionally provide a custom port (by defualt the '5656' is used).
Press 'Save Changes' when ready.

SV8.png
10. After configuring your server correctly, you are going to see the following screen.

Test your connection and API key through pressing 'Test Connection'.
Now, you need to create a new group for your server. For that purpose press 'Create New Group'.

SV9.png
11. Fill in name, choose a previously created server and press 'Add'.

Confirm by clicking on 'Save Changes'.

SV10.png

[edit] Configuration of Product

12. In order to create and configure product, go to 'System Settings' → 'Products/Services'.

Afterwards, click on 'Create a New Group'.

SV11.png
13. Fill in a product group name and press 'Save Changes'.
SV12.png
14. When you have a product group, you can create your product and assign it to SolusVM Extended VPS.

To create a product click on 'Create a New Product'.

SV13.png
15. Afterwards, choose your product type and product group from dropdown menus, fill in your product name and press 'Continue'.
SV14.png
16. Now, go to 'Module Settings' section, choose both 'SolusvmExtendedVPS' and a previously created server group from dropdown menus.

Afterwards, press 'Save Changes'.

SV15.png
17. Start configuration of a product with 'Product Configuration' section.

Select desired 'Virtualization Type' and press 'Save Changes' in order to load the virtualization.

SV16.png
18. Now, choose 'Default Node', 'Plan', 'Default Operating System', 'Number of IPs' and 'Default Node Group'.

Note: default data will be used if no configurable options are generated!

SV17.png
19. Define features available in the client area through marking/unmarking them under 'Client Area Features' section.

Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.

SV17 1.png
20. At the very bottom you may change available nodes names to any friendly name.
SV17 2.png
21. The final step is generating default configurable options.

To do so, press 'Generate Default' near 'Configurable Options' as shown on the screen below.
Any time you wish to refresh the list of your OS Templates and ISO Images press 'Synchronize' button marked on the following screen with a red arrow.
Note 1: You can set up user friendly names for the templates through editing configurable option group assigned to the product.
Note 2: If you remove OS template or ISO image from the configurable option, it will be restored during synchronization.

SV17 3.png
You have just finished the installation and configuration of the module!

[edit] Management

SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers both for your admins and clients.

In addition, it provides you with the ability to offer your clients VPS tailored to their needs.
Owing to the integration with Advanced Billing For WHMCS you can even offer a product, which client will be billed for depending on its usage.

[edit] 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: List of available features depends on the selected virtualization.
Due to that, you have to manually disable features from the client area which are not supported by the selected virtualization.

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

[edit] Management of Server

Module allows your customers to easily manage your server: boot, reboot, shutdown, access SSH/VNC/HTML5 console, enable/disable PAE and PXE or reconfigure network.
Additionally, you can log into control panel, rebuild servers and view usage graphs.

In addition to that, your clients can change hostname and root password.
Depending on the chosen virtualization type and selected in 'Module Settings' options, module allows your customers to mount/unmount ISO and enable/disable TUN/TAP.
Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.

SV21.png
As you can see on the following screen, a VPS of KVM type is different than OpenVZ type.

The most noticeable difference is noVNC Console near Console button.

SV21 1.png

[edit] SSH Console

It's one of the most interesting functionalities is SSH console, where your clients can remotely manage the server. To access it, simply press 'Console' button.

Note: This type of console is available only for OpenVZ & Xen virtualization.

SV22.png

[edit] VNC Console

The module also enables remote access to VNC console.

Note: VNC console is used by KVM and Xen HVM virtualization.

SV23.png

[edit] HTML5 noVNC Console

The module also enables usage of HTML5 noVNC console.

Note: noVNC console is used by KVM and Xen HVM virtualization.

SV23 1.png

[edit] HTML 5 Serial Console

And the last supported console is HTML 5 serial console.

Please be informed that the installation of some dependencies is mandatory within your SoulsVM instance, in order to use the console.
Here is the official SoulsVM documentation regarding the installation of dependencies.

Note: HTML 5 Serial Console is used by OpenVZ and Xen virtualization.

SV23 2.png

[edit] Rebuild

Rebuild feature allows you to change OS template from available OS templates list.

To rebuild your server click on 'Rebuild' button, choose template and confirm by pressing 'Rebuild' button.

SV24.png

[edit] Graphs

Move to 'Graphs' section. You will find there visualizations of your current 'Network Traffic', 'Load Average' and 'Memory Usage'.

Tracking your VPS usage you avoid sudden and unexpected overload.

SV21 2.png

[edit] Rescue Mode (KVM Only)

One of the options available is Rescue Mode that may be turned on/off by the client. It allows to boot the server directly into the rescue mode.

Press to enable this functionality.

SV21 3.png
A pop up window appears, select a kernel from the list of available and enable it. SSH details will be viewed immediately.
SV21 4.png

[edit] 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'.
Usage of unique names other than specified in the above documentation makes it impossible to send emails.
Note: The only supported email template unique names are: 'OpenVZ Virtual Server', 'Xen PV Virtual Server', 'Xen HVM' and 'KVM Virtual Server'.

SV30.png
You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use variables:
  • {$service_custom_field_rootpassword}
  • {$service_custom_field_vncip}
  • {$service_custom_field_vncport}
  • {$service_custom_field_vncpassword}.
SV31.png

[edit] Management of Custom Hooks

Our module allows you to use custom hooks. All you need is knowledge of PHP programming language.

Possible hooks are:

  • solusvmExtendedVPS_customclientarea($params)
  • solusvmExtendedVPS_hostname($params)
  • solusvmExtendedVPS_username($params)
  • solusvmExtendedVPS_AdminLink($params)
  • solusvmExtendedVPS_create_one($params)
  • solusvmExtendedVPS_create_two($params)
  • solusvmExtendedVPS_create_three($params)
  • solusvmExtendedVPS_create_four($params)
  • solusvmExtendedVPS_create_five($params)
  • solusvmExtendedVPS_terminate_pre($params)
  • solusvmExtendedVPS_terminate_post_success($params)
  • solusvmExtendedVPS_terminate_post_error($params)
  • solusvmExtendedVPS_suspend_pre($params)
  • solusvmExtendedVPS_suspend_post_success($params)
  • solusvmExtendedVPS_suspend_post_error($params)
  • solusvmExtendedVPS_unsuspend_pre($params)
  • solusvmExtendedVPS_unsuspend_post_success($params)
  • solusvmExtendedVPS_unsuspend_post_error($params)
  • solusvmExtendedVPS_changepackage_pre($params)
  • solusvmExtendedVPS_changepackage_post_success($params)
  • solusvmExtendedVPS_changepackage_post_error($params)

To enable these hooks, you have to rename file 'custom-rename.php' to 'custom.php'.

SV34.png
Now your hooks are active, but since they are empty they do nothing. To find hooks' details, read a previously edited file.

In the mentioned file you are going to find the hook, information about its time of run, returned values and parameters.
For example, if you have no domains but want to have hostname, you should set default value for hostname.
To do so, find hook 'solusvmExtendedVPS_hostname($params)' and type 'return 'myhostname.com';' inside of it.
It should look like on the screen below:

SV35.png

[edit] Dynamic Server Resources Setup With Configurable Options

If you wish to allow your clients to order servers with resources they choose, use configurable option group.

To generate a configurable option group for a product, head to the 19th step of 'Configuration of Product' instruction.
The final result visible in the order form should be similar to the one presented on the following screen.
Note: Field 'Username' appears only during ordering the first SolusVM VPS by client.
In order to show that field, unmark 'One SolusVM User Per VPS For The Same Client' and mark 'Username When Ordering' checkbox.

SV35 1.png
If automatically generated configurable options do not fulfill your clients' needs, you can edit them using this guide.
SV35 2.png
If you decide to set up pricing depending on the ordered resource, you can find instruction on how to proceed here.
SV35 3.png
If you prefer to charge your clients for server resources they actually use, you can use our Advanced Billing For WHMCS module.

[edit] Management of DNS

When you combine SolusVM Extended VPS 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.
Important: SolusVM Extended VPS For WHMCS is compatible with DNS Manager For WHMCS V2.x.x.

To connect both modules, go to 'Settings' → 'Packages' section of DNS Manager and add a new package.
SV2 26.png
Name the package and provide any details you find useful. Then proceed to 'Item' section.
SV2 27 1.png
Select SolusVM Extended VPS from the list of products and click on 'Add' .
SV2 27.png
Your package should now appear on the list. To change its status click on the button as shown below.
SV2 28.png
Once done, you will see a proper note.
SV2 29.png
Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
SV2 30.png
You can find 'Manage DNS' option also in the left menu.
SV2 30 1.png
Depending on previously chosen settings, your customers will be able to add and remove DNS zones.
SV2 31.png

[edit] Management of Billing

When you combine SolusVM Extended VPS For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.
SV32.png
The module allows you to charge your customers basing on the server resources they use.
SV33.png
With Advanced Billing module, you can also display the current server resource usage and their cost, as well as other allowed in Advanced Billing options that are on offer.
SV34 1.png

[edit] Debug Mode

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

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

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

SV37.png
Remember to turn off Debug Mode after you fix the problem.

[edit] Importing Existing VPS

In this section, you can find short instruction on how to connect one of your clients to your already existing VPS in Solus panel.
Take the following steps to make sure that the process will be carried out properly.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following custom fields:

  • vserverid
  • nodeid

The above-mentioned information has to be consistent with the data from your Solus panel. Now, complete these fields as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

Photo solus.png
3. If the completed data is correct, after refreshing the page, you will see the attached VPS from Solus.
Important! Remember to manually add other missing parameters of the VPS such as domains, credentials, IP Addresses, configurable options, SSH Key, billing cycle, etc. so they match the parameters of the attached VPS from Solus.

[edit] 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 each message carefully, 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. In the current version of SolusVM API there is no possibility to automatically upgrade Virtual Machine, therefore you have to perform this action manually.

Upgrading package in the SolusVM VPS Extended module means upgrading Solus Plan.

4. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
5. If you want a random hostname to be generated, enable the 'Random Hostname' option in the 'Admin Area Features' of the module settings.

[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.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Update of Products

Our module is entirely compatible with SolusVM WHMCS Module (previously known as "SolusVM Pro") and you can easily upgrade your existing products without losing your settings.

1. Go to 'System Settings' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedVPS'.
2. Proceed to 'System Settings' → 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedVPS'.
3. Now, click 'System Settings' → 'Products/Services' → 'Module Settings' of your product and make sure that 'Server Group' is set up correctly.
4. The last step is generating default configurable options and custom fields through clicking on 'Generate default' button.
Your SolusVM Extended VPS product is ready to use!

[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 SolusVM Extended VPS For WHMCS module to unlock these benefits.
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.

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. 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.
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. Your client gets white page with '{"success":"1","status":"1"}' while entering 'Control Panel' .

Cause: SolusVM client area template is based on Bootstrap, which may sometimes cause such errors.
Solution: Switch template used by SolusVM client area.

4. You have received the following error: 
Error 'Fatal error: Call to undefined function mime_content_type() in 
/your_whmcs/clients/modules/servers/solusvmExtendedVPS/solusvmExtendedVPS.php on line 0 '.

Reason: Function 'mime_content_type()' is disabled at your server. Our module uses it in order to detect MIME Content-type for a file.
Solution: Enable function mime_content_type() in your PHP or ask your server provider to do so.

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

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=SolusVM_Extended_VPS_For_WHMCS&oldid=66420"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SolusVM Extended VPS For WHMCS