Personal tools
Namespaces

Variants
Actions

Vultr VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
<meta name="keywords" content="vultr vps for whmcs, vultr vps configuration, whmcs vultr vps management, whmcs vultr vps installation, whmcs vultr vps common problems, about whmcs vultr vps, whmcs vultr vps documentation, whmcs vultr vps faq, whmcs vultr vps help, whmcs vultr vps guide, whmcs vultr vps wiki, whmcs vultr vps tutorial, whmcs vultr vps tips, whmcs vultr vps wiki"></meta>
 
<meta name="keywords" content="vultr vps for whmcs, vultr vps configuration, whmcs vultr vps management, whmcs vultr vps installation, whmcs vultr vps common problems, about whmcs vultr vps, whmcs vultr vps documentation, whmcs vultr vps faq, whmcs vultr vps help, whmcs vultr vps guide, whmcs vultr vps wiki, whmcs vultr vps tutorial, whmcs vultr vps tips, whmcs vultr vps wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Vultr VPS For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Vultr VPS For WHMCS Module."></meta>
−
 
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
 
−
We are sorry for the inconvenience caused.</h4>
 
  
 
=About [https://www.modulesgarden.com/products/whmcs/vultr-vps Vultr VPS For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/vultr-vps Vultr VPS For WHMCS]=
Line 11: Line 8:
 
You will be also allowed to adjust your offer to even the most demanding needs of your clients with a wide range of configurable options.
 
You will be also allowed to adjust your offer to even the most demanding needs of your clients with a wide range of configurable options.
 
|}
 
|}
−
<!--a comment maybe? -->
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
Line 574: Line 570:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VT_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VT_4.png]]
 
|}
 
|}
 +
==Activating Addon Module==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''7. The final step of the module instillation is setting up a cron command that is required for several module features to work properly.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterward, find '' 'Vultr VPS' '' and press the '' 'Activate' '' button.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_4_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''8. In the next step, you need to grant access to this module.'''<br />
 +
To do so, click on the '' 'Configure' '' button, go to the '' 'Access Control' '' area, and check the required admin role groups. Press '' 'Save Changes'.''<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_4_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''9. The final step of the module instillation is setting up a cron command that is required for several module features to work properly.'''<br/>
 
'''''Note:''' The cron execution is required for products in version 1.1.0 and later.''<br/>
 
'''''Note:''' The cron execution is required for products in version 1.1.0 and later.''<br/>
  
Line 583: Line 594:
  
 
Remember to replace "yourWHMCS" with a proper directory. <br/>
 
Remember to replace "yourWHMCS" with a proper directory. <br/>
−
Suggested time interval for cron execution is 5 minutes.
+
The suggested time interval for cron execution is 5 minutes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_4_3.png]]
 
|}
 
|}
  
Line 589: Line 603:
 
{|
 
{|
 
|style="padding: 10px 0px 20px 0px;"|'''Before you can go on, you must generate your Vultr API Token. You will need it to connect with the server successfully.'''<br/>
 
|style="padding: 10px 0px 20px 0px;"|'''Before you can go on, you must generate your Vultr API Token. You will need it to connect with the server successfully.'''<br/>
−
Underneath you will find instructions where to find your API details.
+
Underneath you will find instructions on where to find your API details.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Firstly, log into your Vultr account at: ''https://my.vultr.com/''.  
+
|style="padding: 0px 0px 20px 15px;"|'''10. Firstly, log into your Vultr account at: ''https://my.vultr.com/''.  
 
|}
 
|}
 
{|
 
{|
Line 598: Line 612:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Move to the '' 'API' '' details section under your account.'''
+
|style="padding: 0px 0px 15px 15px;"|'''11. Move to the '' 'API' '' details section under your account.'''
 
There find the '' 'Personal Access Token' '' section and generate your API Key.''' <br/>
 
There find the '' 'Personal Access Token' '' section and generate your API Key.''' <br/>
 
You must previously enable API to be able to generate the API key. Copy the key as you will need in the next steps of the server configuration.  
 
You must previously enable API to be able to generate the API key. Copy the key as you will need in the next steps of the server configuration.  
Line 607: Line 621:
  
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Now, log in to your WHMCS and proceed to '' 'System Settings' '' → '' 'Servers' '' and press '' 'Add New Server'.''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Now, log in to your WHMCS and proceed to '' 'System Settings' '' → '' 'Servers' '' and press '' 'Add New Server'.''
 
|}
 
|}
 
{|
 
{|
Line 613: Line 627:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. Next, enter your server name and a hostname or an IP address. Then select '' 'Vultr VPS' '' from the '' 'Type' '' field.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''13. Next, enter your server name and a hostname or an IP address. Then select '' 'Vultr VPS' '' from the '' 'Type' '' field.<br/>
 
Now, provide the previously generated API token in the '' 'Password' '' field. Then check the connection, if successful, save the changes.
 
Now, provide the previously generated API token in the '' 'Password' '' field. Then check the connection, if successful, save the changes.
 
|}
 
|}
Line 620: Line 634:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. It is time to create a server group. To do so, click on '' 'Create Server Group'.'' '''
+
|style="padding: 0px 0px 20px 15px;"|'''14. It is time to create a server group. To do so, click on '' 'Create Server Group'.'' '''
 
|}
 
|}
 
{|
 
{|
Line 626: Line 640:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes'.'' '''
+
|style="padding: 0px 0px 20px 15px;"|'''15. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes'.'' '''
 
|}
 
|}
 
{|
 
{|
Line 634: Line 648:
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services'.'' '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''16. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services'.'' '''<br />
 
Click on '' 'Create a New Group' ''.
 
Click on '' 'Create a New Group' ''.
 
|}
 
|}
Line 641: Line 655:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Enter a product group name and press '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 15px;"|'''17. Enter a product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 647: Line 661:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can create your product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''18. When you have a product group, you can create your product.'''<br />
 
To create a product click on '' 'Create a New Product' ''.  
 
To create a product click on '' 'Create a New Product' ''.  
 
|}
 
|}
Line 654: Line 668:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Afterward, choose your product group and type from the dropdown menus, enter your product name and press '' 'Continue'. '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''19. Afterward, choose your product group and type from the dropdown menus, enter your product name and press '' 'Continue'. '' '''<br />
 
'' 'Product Type' '' should be set to '' 'Shared Hosting'. ''
 
'' 'Product Type' '' should be set to '' 'Shared Hosting'. ''
 
|}
 
|}
Line 661: Line 675:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, go to the '' 'Module Settings' '' section, choose both '' 'Vultr VPS' '' and your previously created server group from the dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''20. Now, go to the '' 'Module Settings' '' section, choose both '' 'Vultr VPS' '' and your previously created server group from the dropdown menus.'''<br />
 
The module should automatically save and reload settings. If not, click on '' 'Save Changes' '' manually.'''
 
The module should automatically save and reload settings. If not, click on '' 'Save Changes' '' manually.'''
 
|}
 
|}
Line 668: Line 682:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''18. Start from defining the '' 'Configuration' '' details.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''21. Start from defining the '' 'Configuration' '' details.<br/>
 
* '''Region''' - choose one of the geographical areas with the preferred predefined set of resources for your VPS.<br/>
 
* '''Region''' - choose one of the geographical areas with the preferred predefined set of resources for your VPS.<br/>
−
Set one of the below four options: '''Operating System''', '''ISO''', '''Snapshot''' or '''Application.''' Leave the other three as '' 'Disabled'.''
+
* '''Default Reverse DNS Template''' - define the default format for reverse DNS entries using supported Smarty variables to represent parts of the IP address.
−
* '''Operating System''' - you may choose one of the operating systems to be used when creating your virtual machine.<br/>'''''Note:''' Keep in mind that Vultr includes Windows licenses (Core and Standard) in their Plans and charges a monthly fee for them.''<br/>''Since this will affect the Plan price, we recommend not including Windows with other systems in one product.''
+
* '''DDOS Protection''' - add an extra layer of security by enabling DDOS protection.
−
* '''ISO''' - use an ISO that you have previously created in your Vultr panel to install the virtual machine.
+
−
* '''Snapshot''' - you may also install the virtual machine using one of the existing snapshots. <br/>
+
−
* '''Application''' - select an application to install it automatically upon the instance creation.<br/>
+
−
Move to setting up the rest of configuration options:
+
−
* '''IPv6''' - turn on IPv6 type of IP addresses for the VPS.
+
−
* '''DDOS Protection''' - add an extra layer of security by enabling DDOS protection .
+
 
* '''Plan''' - choose a plan to install the virtual machine.
 
* '''Plan''' - choose a plan to install the virtual machine.
 
* '''User Data''' - enter the user data to run common configuration tasks when your instance starts. You can run cloud-init directives or shell scripts for Linux images. You may use smarty variables, e.g. ''{$password}.''<br/>  '''''Note:''' Please refer to the following article to find a '''list of supported [https://developers.whmcs.com/provisioning-modules/module-parameters/ module parameters]''' and their descriptions.''  
 
* '''User Data''' - enter the user data to run common configuration tasks when your instance starts. You can run cloud-init directives or shell scripts for Linux images. You may use smarty variables, e.g. ''{$password}.''<br/>  '''''Note:''' Please refer to the following article to find a '''list of supported [https://developers.whmcs.com/provisioning-modules/module-parameters/ module parameters]''' and their descriptions.''  
Line 685: Line 693:
 
* '''Use Hostname in Label Field''' - enable this option to be allowed to provide the hostname into the Label field.
 
* '''Use Hostname in Label Field''' - enable this option to be allowed to provide the hostname into the Label field.
 
* '''Enable White Label noVNC Console''' - toggle this option to enable the noVNC console '''without any Vultr labels.'''<br/> '''''Important:''' To use a white-label console, please contact the Vultr support first!''  
 
* '''Enable White Label noVNC Console''' - toggle this option to enable the noVNC console '''without any Vultr labels.'''<br/> '''''Important:''' To use a white-label console, please contact the Vultr support first!''  
 +
* '''Default Application Group''' - group of applications allowed for reinstalls, see the [[#Groups|groups]] section.
 +
* '''Default Application''' - default application to be installed on the VPS.
 
|}
 
|}
 
{|
 
{|
Line 690: Line 700:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. Next, select features available at the client area.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''22. Next, select features available at the client area.'''<br />
 
You can also decide which images used to rebuild the server will be available to your customers.
 
You can also decide which images used to rebuild the server will be available to your customers.
 
|}
 
|}
Line 697: Line 707:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Enable additional options and set up configuration per each one of them:'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''23. Enable additional options and set up configuration per each one of them:'''<br />
−
* '''Block Storage''' - define the storage size between 10 and 10 000 GB, note that if you also decide to enable this configurable option, it will overwrite the general product settings<br/> '''''Important:''' It is impossible to successfully downgrade block storage.''
+
* '''Block Storage''' - define the storage size between 10 and 10 000 GB, note that if you also decide to enable this configurable option, it will overwrite the general product settings.<br/> '''''Important:''' It is impossible to successfully downgrade block storage.''
−
 
+
* '''Snapshot''' - define the snapshot limit that the client is allowed to create.
−
* '''Reserved IPs''' - define the limit of IPv4 and IPv6 addresses that can be added to the bundle of reserved IPs
+
* '''Reserved IPs''' - define the limit of IPv4 and IPv6 addresses that can be added to the bundle of reserved IPs.
 
|}
 
|}
 
{|
 
{|
Line 706: Line 716:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''24. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.'''<br/>
−
Configurable options can be used by your clients to select each virtual machine parameters individually during order placement.<br/>Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
+
Configurable options can be used by your clients to select each virtual machine parameter individually during order placement.<br/>Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
 
|}
 
|}
 
{|
 
{|
Line 714: Line 724:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|If you decide to use configurable options, press the '' 'Create' '' button and select which options you want to generate.<br/>  
 
|style="padding: 0px 0px 15px 15px;"|If you decide to use configurable options, press the '' 'Create' '' button and select which options you want to generate.<br/>  
−
Remember that only one of the four options: 'osapp_id|Operating System or Application' 'os_id|Operating System', 'iso_id|ISO', 'snapshot_id|Snapshot', 'app_id|Application' can be used at once!<br/> In case more than just one option is left for the client to select, they will be taken into consideration in the following manner: 
 
−
#'' 'osapp_id|Operating System or Application' ''
 
−
#'' 'os_id|Operating System' ''
 
−
#'' 'Snapshot' ''
 
−
#'' 'ISO' ''
 
−
#'' 'Application' '' as the last one.<br/>
 
−
 
 
Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/> More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
 
Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/> More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
 
|}
 
|}
Line 728: Line 731:
  
 
=Management=
 
=Management=
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|'''This guide is divided into three main sections to provide a clear and comprehensive understanding of the module's functionality.'''<br/>
 +
The first section, '' '[[#Addon|Addon]]','' covers the basic configuration and management of the module addon.<br/>
 +
The second section, '' '[[#Admin_Area|Admin Area]]' '' focuses on VPS management from the admin area.<br/>
 +
Finally, the third section, '' '[[#Client_Area|Client Area]]' '' delves into the client area, explaining how users can manage their VPS.<br/>
 +
 +
Each part is designed to give you an easy-to-understand overview of the module's features.
 +
|}
 +
==Addon==
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|The addon provides administrators with the tools to efficiently monitor and manage the module's functionality, while also offering customization options tailored to client needs.<br/>
 +
It includes a task queue for managing pending actions, a logs section for tracking activity, and an app templates for preparing applications for clients.<br/>
 +
Additionally, the media library allows for the easy upload of images to be used within the module.<br/>
 +
The translations tool enables admins to add client languages and translate the module, ensuring a fully localized experience.
 +
|}
 +
===Queue===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|In this section, you will find a list of all the tasks issued by the module.<br/>
 +
You can filter tasks by type with the '' 'Show' '' buttons.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The information on each task includes:
 +
*'''Task ID'''
 +
*'''Related item'''
 +
*'''Task status'''
 +
*'''Task type'''
 +
*'''Attempts taken'''
 +
*'''Date of creation'''
 +
*'''Date of the last status update'''
 +
You may also use the action buttons to:
 +
*'''See task details'''
 +
*'''Manually run the task'''
 +
*'''Delete the task'''
 +
To find specific tasks use the search and sorting functions.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Task details include:
 +
*'''Task ID'''
 +
*'''Job'''
 +
*'''Queue'''
 +
*'''Retry Count'''
 +
*'''Parent ID'''
 +
*'''Type'''
 +
*'''Related Item'''
 +
*'''Custom Relation'''
 +
*'''Status'''
 +
*'''Retry After Date'''
 +
*'''Created At Date'''
 +
*'''Updated At Date'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Related log entries can be found in a separate tab.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Tasks can also be deleted with the mass action function.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Additional actions include the '' 'Auto Prune' '' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_6.png]]
 +
|}
 +
 +
===App Templates===
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|App templates allow you to manage and ultimately provison applications, ISOs, OSes and snapshots to you clients.<br/>
 +
Prepare templates in the '' 'Applications' '' tab and gather them into groups in the '' 'Groups' '' tab.<br/>
 +
For clients to be able to install templates on their VPS, their product has to include an '' 'Application Group' '' and allow '' 'App Templates' '' under '' 'Client Area Features'.''
 +
|}
 +
====Applications====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Read the guide carefully, as it contains crucial information about App Templates.<br/>
 +
You can hide the guide afterward by clicking on the hide button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can switch between Applications, ISO Images, Operating Systems, and Snapshots by clicking on relevant tabs.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can use the refresh button to download and later refresh templates from the server.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Once the items are loaded, you can use the action buttons to edit, duplicate or delete them from the list.<br/>
 +
You can also use the mass action buttons to manage multiple templates at once
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_11.png]]
 +
|}
 +
 +
====Groups====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|With the templates ready, all that is left is to gather them into groups and include said groups into products.<br/>
 +
Navigate to '' 'App Templates' '' → '' 'Groups' '' and click on the '' 'Create' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Read the information, then provide the group with:
 +
*Name
 +
*Description
 +
*Items to include
 +
'''''Note:''' Keep in mind that Vultr includes Windows licenses (Core and Standard) in their Plans and charges a monthly fee for them.''<br/>''Since this will affect the Plan price, we recommend not including Windows with other systems in one product.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can use the action button and the mass action function to edit and delete groups.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|For the client to take advantage of the application templates, the product module settings have to include the group.<br/>
 +
Find the '' 'App Templates Configuration' '' section and '' 'Default Application Group' '' field.<br/>
 +
Include a chosen group for the product.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Make sure '' 'App Templates' '' section is enabled under '' 'Client Area Features'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_19.png]]
 +
|}
 +
<!---
 +
====Advanced Configuration====
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The create button allows you to create a new template manually.<br/>
 +
Provide:
 +
*Name
 +
*Description
 +
*Status (Active/Disabled)
 +
*Image
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|After adding a template click on the edit button to customize it further.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Find the '' 'Setting Details' '' section.<br/>
 +
This is where you can change the template's details.<br/>
 +
Click on the '' 'Create' '' button to create a new setting item.<br/>
 +
???<br/>
 +
???
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_14.png]]
 +
|}
 +
--->
 +
 +
===Media Library===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The media library allows you to upload images for use elsewhere in the module by admins and clients.<br/>
 +
To upload a new picture, click on the '' 'Upload Image' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can delete images one by one by clicking on them.<br/>
 +
To delete all images at once, use the additional action button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_21.png]]
 +
|}
 +
 +
===Other===
 +
====[https://www.docs.modulesgarden.com/Translations_Tool Translations]====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/>
 +
Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_22.png]]
 +
|}
 +
 +
====Logs====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The '' 'Logs' '' section under '' 'Other' '' is where the module logs are stored.<br/>
 +
You can filter the module logs by type with the '' 'Show' '' buttons:
 +
*'''Critical'''
 +
*'''Error'''
 +
*'''Notice'''
 +
*'''All (Total)'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can delete logs either one by one or with the mass function.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Additional actions include:
 +
*'''Logging Settings'''
 +
*'''Log Export'''
 +
*'''Rule Based Deletion'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In the settings you may decide:
 +
*'''Log Types''' - which type of logs should be recorded.
 +
*'''Clear automatically''' - if you would like to automatically delete logs older than defined number of days.
 +
*'''Delete Logs Older Than''' - how many days should pass before logs are automatically deleted.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|While exporting you will have to specify which logs to export:
 +
*'''From'''
 +
*'''To'''
 +
*'''Log Types'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You may also delete specific logs without finding them manually.<br/> Simply define:
 +
*'''Log Types'''
 +
*'''Delete Logs Older Than'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_28.png]]
 +
|}
 +
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
Line 746: Line 1,010:
 
==Ordering==
 
==Ordering==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.<br />
+
|style="padding: 10px 0px 15px 15px;"|Owing to configurable options, you are able to offer a product that your clients can tailor according to their needs.<br />
−
Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.<br />
+
Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.<br />
 
'''Important: VPS is not created immediately after pressing '' 'Create' ''. Therefore, it is wise to inform your clients about the delay.'''
 
'''Important: VPS is not created immediately after pressing '' 'Create' ''. Therefore, it is wise to inform your clients about the delay.'''
 
|}
 
|}
Line 771: Line 1,035:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Vultr VPS should look like the one on the screen below. As you can see, the control panel contains useful options needed for managing a virtual machine.<br />
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Vultr VPS should look like the one on the screen below. As you can see, the control panel contains useful options needed for managing a virtual machine.<br />
−
The module allows your customers to easily start/stop, reboot or reinstall their servers by pressing the specific button.<br />
+
The module allows your customers to easily start/stop, reboot, or reinstall their servers by pressing a specific button.<br />
−
Clients can also access the VNC console, manage backups, view bandwidth graph and many others.
+
Clients can also access the VNC console, manage backups, view bandwidth graphs, and many others.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_23.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_23.png]]
 +
|}
 +
===App Templates===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The App Center allows you to easily install applications, ISO images, operating systems and snapshots on your VPS.<br/>
 +
'''''Important:''' Installations will wipe all existing data from the machine.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_23_1.png]]
 
|}
 
|}
  
 
===Backups===
 
===Backups===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The first section available for clients grants ability to view the list of existing '' 'Backups' '' of your server. <br/> Please remember that '' 'Backups' '' are assigned to a particular server and will be removed once the server is deleted. <br/>  
+
|style="padding: 10px 0px 15px 15px;"|The first section available for clients grants the ability to view the list of existing '' 'Backups' '' of your server. <br/> Please remember that '' 'Backups' '' are assigned to a particular server and will be removed once the server is deleted. <br/>  
−
'''''Note:''' There is a limit of maximum two backups per server. Once a new backup is created, the oldest one is automatically removed.''
+
'''''Note:''' There is a limit of a maximum of two backups per server. Once a new backup is created, the oldest one is automatically removed.''
 
|}
 
|}
 
{|
 
{|
Line 787: Line 1,059:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Clients are also given the opportunity to schedule incoming backup by pressing the '' 'Schedule Backups' '' button.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Clients are also given the opportunity to schedule incoming backups by pressing the '' 'Schedule Backups' '' button.<br/>
 
Provide a time details to wait until the next backup is created.
 
Provide a time details to wait until the next backup is created.
 
|}
 
|}
Line 799: Line 1,071:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_26.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_26.png]]
 +
|}
 +
 +
===Console===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is a noVNC console where your clients can remotely manage their servers.<br /> To access it, simply click on the '' 'Console' '' button.<br/>
 +
'''''Note:''' Vultr offers a generic VNC URL that serves as a white-label URL. If you wish to use a white-label console with the Vulr VPS For WHMCS module, please contact the '''Vultr support''' via their official ticketing system.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:VT_33.png]]
 
|}
 
|}
  
Line 812: Line 1,093:
 
===Firewall===
 
===Firewall===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The firewall management page allows your customers to view, add or delete existing rules on a security group assigned to the product.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The firewall management page allows your customers to view, add, or delete existing rules on a security group assigned to the product.<br/>
 
To add a new firewall rule, use the button marked on the following screen.<br/>
 
To add a new firewall rule, use the button marked on the following screen.<br/>
 
'''''Note:''' Please remember that there is a limit of 50 firewall rules. If you reach this limit, you will not be allowed to create new ones before removing any existing ones.''
 
'''''Note:''' Please remember that there is a limit of 50 firewall rules. If you reach this limit, you will not be allowed to create new ones before removing any existing ones.''
Line 845: Line 1,126:
 
===Private Network===
 
===Private Network===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The next section allows assigning private network to a machine. Simply press the button marked on the screen and select from the dropdown list.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The next section allows assigning a private network to a machine. Simply press the button marked on the screen and select from the dropdown list.<br/>
 
Confirm the action.
 
Confirm the action.
 
|}
 
|}
Line 853: Line 1,134:
 
-->
 
-->
  
−
===Rebuild===
+
===Reserved IP Addresses===
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|The rebuild feature allows your clients to change a server image.<br />
+
−
To reinstall your server, choose an image and confirm through pressing the '' 'Rebuild' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:VT_30.png]]
+
−
|}
+
−
 
+
−
===Reserved IPs===
+
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|This section includes a list of all existing in the panel reserved IP addresses. <br/>
 
|style="padding: 10px 0px 15px 15px;"|This section includes a list of all existing in the panel reserved IP addresses. <br/>
Line 915: Line 1,187:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_35.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:VT_35.png]]
−
|}
 
−
 
−
===Console===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is a noVNC console where your clients can remotely manage their servers.<br /> To access it, simply click on the '' 'Console' '' button.<br/>
 
−
'''''Note:''' Vultr offers a generic VNC URL that serves as a white-label URL. If you wish to use a white-label console with the Vulr VPS For WHMCS module, please contact the '''Vultr support''' via their official ticketing system.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:VT_33.png]]
 
 
|}
 
|}
  
Line 937: Line 1,200:
 
=Update Instructions=
 
=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/>
+
|style="padding: 10px 0px 15px 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.
 
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.
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''While upgrading to version 2.x make sure to follow those guidelines:'''<br/>
 +
1. Make sure '''all tasks are finished''', as the migration process will delete them.<br/>
 +
2. Optionally, back up your '''customized language files'''.<br/>
 +
3. '''Delete all files''' from the previous version of the module.<br/>
 +
4. Upload the '''new module files'''.<br/>
 +
5. Manually initiate the version upgrade with '''the cron command''':
 +
php -q /YOUR_WHMCS/modules/servers/VultrVps/cron/cron.php upgrade run 2.0.0
 +
6. Optionally, restore changes made to the language files.
 +
|}
 +
 
=Upgrade Guide=
 
=Upgrade Guide=
 
{|
 
{|
Line 954: Line 1,228:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. Downgrading virtual machine with block storage is impossible. Move to the official [https://www.vultr.com/docs/block-storage#How_to_Downgrade_Block_Storage Vultr documentation] to find out more.
+
|style="padding: 0px 0px 30px 15px;"|2. Downgrading virtual machines with block storage is impossible. Move to the official [https://www.vultr.com/docs/block-storage#How_to_Downgrade_Block_Storage Vultr documentation] to find out more.
 
|}
 
|}

Revision as of 16:55, 21 November 2024

Contents

About Vultr VPS For WHMCS

Vultr VPS For WHMCS is a module that allows fully automated management of Vultr VPS servers.

The module will allow your clients to remotely control the status of a server, access the console, rebuild the VPS and many others.
You will be also allowed to adjust your offer to even the most demanding needs of your clients with a wide range of configurable options.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Change Package
✔ Start/Stop/Reboot/Reinstall Server
✔ Access noVNC Console
✔ View Instance Status And Details
✔ View Assigned Public IPv4 And IPv6 Network Details
✔ View/Schedule/Restore Automatic Backups
✔ View/Create Firewall Rules
✔ View/Create/Restore Snapshots
✔ View/Create/Manage Reverse DNS Records
✔ View Assigned Reserved IP Addresses
✔ Configure Product Details:
✔ Choose Region
✔ Choose Plan
✔ Choose Operation System
✔ Choose ISO Image
✔ Choose Snapshot
✔ Choose Application
✔ Toggle Automatic Backups
✔ Toggle IPv6 Address
✔ Toggle DDOS Protection
✔ Use Hostname In Label Field
✔ Enable White Label noVNC Console
✔ Provide Random Domain Prefix
✔ Provide Default Reverse DNS Template
✔ Provide Cloud-Init User-Data Initiation Script
✔ Choose Features Available In Client Area:
✔ Backups
✔ Firewall
✔ Rebuild
✔ Reverse DNS
✔ User Data
✔ Available Images To Rebuild
✔ Console
✔ Graphs
✔ Snapshots
✔ Reserved IPs
✔ Custom ISO
✔ Available ISO Images To Mount
✔ Enable Instance Block Storage With Defined Type And Size
✔ Enable Reserved IPv4 And IPv6 Addresses Within Defined Limits
✔ Generate Configurable Options
✔ Run API Connection Test
  • Client Area Features:
✔ Start/Stop/Reboot/Reinstall Server
✔ Access noVNC Console
✔ View Instance Status And Details
✔ View Assigned Public IPv4 And IPv6 Network Details
✔ View/Schedule/Restore Automatic Backups
✔ Mount Custom ISO Images
✔ View/Create Firewall Rules
✔ View Bandwidth Usage Graph
✔ Rebuild Server With Chosen OS Distribution
✔ View Assigned Reserved IP Addresses
✔ View/Create/Manage Reverse DNS Records
✔ View/Create/Restore/Delete Snapshots
✔ Provide Cloud-Init User-Data Initiation Script
  • Configurable Options:
✔ Application
✔ Backups
✔ Block Storage Size
✔ Block Storage Type
✔ DDOS Protection
✔ IPv6
✔ ISO Image
✔ Operating System or Application
✔ Operating System
✔ Plan
✔ Region
✔ Reserved IPv4
✔ Reserved IPv6
✔ Snapshot
  • Available Images And Applications:
✔ Linux OS:
✔ AlmaLinux
✔ Arch Linux
✔ CentOS
✔ Debian
✔ Fedora
✔ Fedora CoreOS
✔ FreeBSD
✔ OpenBSD
✔ Rocky Linux
✔ Ubuntu
✔ VzLinux
✔ Microsoft Windows:
✔ Windows Core 2022
✔ Windows Core 2019
✔ Windows Core 2016
✔ Windows Server 2022
✔ Windows Server 2019
✔ Windows Server 2016
✔ Windows Server 2012 RS
✔ Marketplace Apps:
✔ 3DKit
✔ AIDungeon2
✔ Anaconda
✔ Ant Media Server (Community Edition/Enterprise Edition)
✔ Asp.net
✔ AzuraCast
✔ Bitnami via Vultr (Jenkins/Magento/PrestaShop)
✔ BotGuard Ingress Controller
✔ CentOS Web Panel
✔ Chevereto
✔ CloudHub
✔ CloudPanel 2
✔ Cloudron
✔ ClusterControl
✔ Coder
✔ cPanel
✔ CyberPanel
✔ Docker
✔ Drupal
✔ Easypanel
✔ FASTPANEL
✔ FileCloud
✔ Gitea
✔ GitLab
✔ Helpy Pro
✔ Jamulus
✔ Jelastic DevOps PaaS
✔ Jitsi
✔ Joomla
✔ Keitaro
✔ LAMP
✔ LEMP
✔ Lume Web DNS Relay
✔ Mediawiki
✔ Microweber Website Builder
✔ Minecraft (Bedrock/Forge/PaperSpigot/Vanilla)
✔ Miniconda
✔ Mist Community Edition
✔ MLDev/MLDev Basic
✔ Nextcloud
✔ NirvaShare
✔ NodeJS
✔ NVIDIA Docker
✔ ONLYOFFICE (Docs/Workspace)
✔ OpenLiteSpeed (Django/Drupal/Joomla/NodeJS/Rails/WordPress)
✔ OpenVPN Access Server
✔ Owncast
✔ ownCloud
✔ Plesk (Web Admin SE/Web Host/Web Pro)
✔ PrestaShop
✔ Pritunl
✔ PyboxTech-Med
✔ Restyaboard
✔ Roxy-WI
✔ RunCloud Nginx
✔ ServerWand
✔ Squidex
✔ Steam
✔ Ubuntu Desktop (Gnome/KDE/XFCE)
✔ UTunnel VPN
✔ VDev
✔ VitalPBX
✔ WarpSpeed VPN
✔ Webmin
✔ WooCommerce
✔ WordPress
✔ Yarn
✔ ISO Library To Mount:
✔ Finnix
✔ GParted
✔ Hiren's BootCD PE
✔ SystemRescue
✔ Any Other OS Platforms And Solutions When Made Available By Vultr
  • General Info:
✔ Fully Integrated With Lagom WHMCS Client Theme
✔ Multi-Language Support
✔ Supports PHP 8.2 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.11 Back To WHMCS V8.8
✔ Requires ionCube Loader V13 Or Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure Vultr VPS For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download the module.
VT 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

VT 2.png
4. When you install Vultr VPS For WHMCS for the first time you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/VultrVps/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

VT 3.png
5. In order to configure your license key, you have to edit the 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'.

VT 3 1.png
6. Now, set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/servers/VultrVps/'.

VT 4.png

Activating Addon Module

7. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterward, find 'Vultr VPS' and press the 'Activate' button.

VT 4 1.png
8. In the next step, you need to grant access to this module.

To do so, click on the 'Configure' button, go to the 'Access Control' area, and check the required admin role groups. Press 'Save Changes'.

VT 4 2.png
9. The final step of the module instillation is setting up a cron command that is required for several module features to work properly.

Note: The cron execution is required for products in version 1.1.0 and later.

php -q /yourWHMCS/modules/servers/VultrVps/cron/cron.php queue

Remember to replace "yourWHMCS" with a proper directory.
The suggested time interval for cron execution is 5 minutes.

VT 4 3.png

Configuration of Server

Before you can go on, you must generate your Vultr API Token. You will need it to connect with the server successfully.

Underneath you will find instructions on where to find your API details.

10. Firstly, log into your Vultr account at: https://my.vultr.com/.
VT 5.png
11. Move to the 'API' details section under your account.

There find the 'Personal Access Token' section and generate your API Key.
You must previously enable API to be able to generate the API key. Copy the key as you will need in the next steps of the server configuration.

VT 6.png
12. Now, log in to your WHMCS and proceed to 'System Settings' → 'Servers' and press 'Add New Server'.
VT 7.png
13. Next, enter your server name and a hostname or an IP address. Then select 'Vultr VPS' from the 'Type' field.

Now, provide the previously generated API token in the 'Password' field. Then check the connection, if successful, save the changes.

VT 8.png
14. It is time to create a server group. To do so, click on 'Create Server Group'.
VT 9.png
15. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'.
VT 10.png

Configuration of Product

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

Click on 'Create a New Group' .

VT 11.png
17. Enter a product group name and press 'Save Changes'.
VT 12.png
18. When you have a product group, you can create your product.

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

VT 13.png
19. Afterward, choose your product group and type from the dropdown menus, enter your product name and press 'Continue'.

'Product Type' should be set to 'Shared Hosting'.

VT 14.png
20. Now, go to the 'Module Settings' section, choose both 'Vultr VPS' and your previously created server group from the dropdown menus.

The module should automatically save and reload settings. If not, click on 'Save Changes' manually.

VT 15.png
21. Start from defining the 'Configuration' details.
  • Region - choose one of the geographical areas with the preferred predefined set of resources for your VPS.
  • Default Reverse DNS Template - define the default format for reverse DNS entries using supported Smarty variables to represent parts of the IP address.
  • DDOS Protection - add an extra layer of security by enabling DDOS protection.
  • Plan - choose a plan to install the virtual machine.
  • User Data - enter the user data to run common configuration tasks when your instance starts. You can run cloud-init directives or shell scripts for Linux images. You may use smarty variables, e.g. {$password}.
    Note: Please refer to the following article to find a list of supported module parameters and their descriptions.
  • Random Domain Prefix - enter the domain prefix that will be used when a domain is not provided.
  • Automatic Backups - turn on aromatic backups creation.
  • IPv6 - enable to use the IPv6 addresses type for the VPS.
  • Use Hostname in Label Field - enable this option to be allowed to provide the hostname into the Label field.
  • Enable White Label noVNC Console - toggle this option to enable the noVNC console without any Vultr labels.
    Important: To use a white-label console, please contact the Vultr support first!
  • Default Application Group - group of applications allowed for reinstalls, see the groups section.
  • Default Application - default application to be installed on the VPS.
VT 16.png
22. Next, select features available at the client area.

You can also decide which images used to rebuild the server will be available to your customers.

VT 17.png
23. Enable additional options and set up configuration per each one of them:
  • Block Storage - define the storage size between 10 and 10 000 GB, note that if you also decide to enable this configurable option, it will overwrite the general product settings.
    Important: It is impossible to successfully downgrade block storage.
  • Snapshot - define the snapshot limit that the client is allowed to create.
  • Reserved IPs - define the limit of IPv4 and IPv6 addresses that can be added to the bundle of reserved IPs.
VT 17 1.png
24. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.

Configurable options can be used by your clients to select each virtual machine parameter individually during order placement.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.

VT 18.png
If you decide to use configurable options, press the 'Create' button and select which options you want to generate.

Note that the configuration for disabled options will still be taken from the configuration of the main product.
More information about how to use configurable options can be found here or in the official WHMCS documentation.

VT 19.png

Management

This guide is divided into three main sections to provide a clear and comprehensive understanding of the module's functionality.

The first section, 'Addon', covers the basic configuration and management of the module addon.
The second section, 'Admin Area' focuses on VPS management from the admin area.
Finally, the third section, 'Client Area' delves into the client area, explaining how users can manage their VPS.

Each part is designed to give you an easy-to-understand overview of the module's features.

Addon

The addon provides administrators with the tools to efficiently monitor and manage the module's functionality, while also offering customization options tailored to client needs.

It includes a task queue for managing pending actions, a logs section for tracking activity, and an app templates for preparing applications for clients.
Additionally, the media library allows for the easy upload of images to be used within the module.
The translations tool enables admins to add client languages and translate the module, ensuring a fully localized experience.

Queue

In this section, you will find a list of all the tasks issued by the module.

You can filter tasks by type with the 'Show' buttons.

VT 19 1.png
The information on each task includes:
  • Task ID
  • Related item
  • Task status
  • Task type
  • Attempts taken
  • Date of creation
  • Date of the last status update

You may also use the action buttons to:

  • See task details
  • Manually run the task
  • Delete the task

To find specific tasks use the search and sorting functions.

VT 19 2.png
Task details include:
  • Task ID
  • Job
  • Queue
  • Retry Count
  • Parent ID
  • Type
  • Related Item
  • Custom Relation
  • Status
  • Retry After Date
  • Created At Date
  • Updated At Date
VT 19 3.png
Related log entries can be found in a separate tab.
VT 19 4.png
Tasks can also be deleted with the mass action function.
VT 19 5.png
Additional actions include the 'Auto Prune' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information.
VT 19 6.png

App Templates

App templates allow you to manage and ultimately provison applications, ISOs, OSes and snapshots to you clients.

Prepare templates in the 'Applications' tab and gather them into groups in the 'Groups' tab.
For clients to be able to install templates on their VPS, their product has to include an 'Application Group' and allow 'App Templates' under 'Client Area Features'.

Applications

Read the guide carefully, as it contains crucial information about App Templates.

You can hide the guide afterward by clicking on the hide button.

VT 19 8.png
You can switch between Applications, ISO Images, Operating Systems, and Snapshots by clicking on relevant tabs.
VT 19 9.png
You can use the refresh button to download and later refresh templates from the server.
VT 19 10.png
Once the items are loaded, you can use the action buttons to edit, duplicate or delete them from the list.

You can also use the mass action buttons to manage multiple templates at once

VT 19 11.png

Groups

With the templates ready, all that is left is to gather them into groups and include said groups into products.

Navigate to 'App Templates' → 'Groups' and click on the 'Create' button.

VT 19 15.png
Read the information, then provide the group with:
  • Name
  • Description
  • Items to include

Note: Keep in mind that Vultr includes Windows licenses (Core and Standard) in their Plans and charges a monthly fee for them.
Since this will affect the Plan price, we recommend not including Windows with other systems in one product.

VT 19 16.png
You can use the action button and the mass action function to edit and delete groups.
VT 19 17.png
For the client to take advantage of the application templates, the product module settings have to include the group.

Find the 'App Templates Configuration' section and 'Default Application Group' field.
Include a chosen group for the product.

VT 19 18.png
Make sure 'App Templates' section is enabled under 'Client Area Features'.
VT 19 19.png

Media Library

The media library allows you to upload images for use elsewhere in the module by admins and clients.

To upload a new picture, click on the 'Upload Image' button.

VT 19 20.png
You can delete images one by one by clicking on them.

To delete all images at once, use the additional action button.

VT 19 21.png

Other

Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon.
Its user-friendly design makes managing various language file tweaks a smooth and efficient process.

Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

VT 19 22.png

Logs

The 'Logs' section under 'Other' is where the module logs are stored.

You can filter the module logs by type with the 'Show' buttons:

  • Critical
  • Error
  • Notice
  • All (Total)
VT 19 23.png
You can delete logs either one by one or with the mass function.
VT 19 24.png
Additional actions include:
  • Logging Settings
  • Log Export
  • Rule Based Deletion
VT 19 25.png
In the settings you may decide:
  • Log Types - which type of logs should be recorded.
  • Clear automatically - if you would like to automatically delete logs older than defined number of days.
  • Delete Logs Older Than - how many days should pass before logs are automatically deleted.
VT 19 26.png
While exporting you will have to specify which logs to export:
  • From
  • To
  • Log Types
VT 19 27.png
You may also delete specific logs without finding them manually.
Simply define:
  • Log Types
  • Delete Logs Older Than
VT 19 28.png

Admin Area

Vultr VPS For WHMCS allows your customers to manage their servers via the client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options that enable you to view current resources and change specifications through changing configurable options and pressing 'Change Package'
2. Module commands (Create, Suspend/Unsuspend, Change Package)
3. Scheduled tasks - list of tasks to be performed with the cron execution 4. Service actions (Start/Stop VM, Reboot, Reinstall, Access Console)
5. Instance details along with Public Network IPv4 and IPv6 details (the latter one is available only if you enable it in the product's configuration)
6. Backups, firewall rules, snapshots management sections
7. Reverse DNS management and a preview of reserved IP addresses.

VT 21.png

Ordering

Owing to configurable options, you are able to offer a product that your clients can tailor according to their needs.

Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.
Important: VPS is not created immediately after pressing 'Create' . Therefore, it is wise to inform your clients about the delay.

VT 22.png

Importing Existing Instance

In this section, you can find short instructions on how to connect one of your clients to your already existing instance in the Vultr 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 empty field:

  • Instance ID

The above-mentioned information has to be consistent with the data from your Vultr panel. Now, complete this field 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'.

Vultr import.png
3. If the completed data is correct, after refreshing the page, you will see the attached instance from Vultr.
Important! Remember to manually add other missing parameters of the instance such as domains, credentials, IP Addresses, configurable options, etc. so they match the parameters of the attached instance from Vultr panel.

Client Area

Client area interface of Vultr VPS should look like the one on the screen below. As you can see, the control panel contains useful options needed for managing a virtual machine.

The module allows your customers to easily start/stop, reboot, or reinstall their servers by pressing a specific button.
Clients can also access the VNC console, manage backups, view bandwidth graphs, and many others.

VT 23.png

App Templates

The App Center allows you to easily install applications, ISO images, operating systems and snapshots on your VPS.

Important: Installations will wipe all existing data from the machine.

VT 23 1.png

Backups

The first section available for clients grants the ability to view the list of existing 'Backups' of your server.
Please remember that 'Backups' are assigned to a particular server and will be removed once the server is deleted.

Note: There is a limit of a maximum of two backups per server. Once a new backup is created, the oldest one is automatically removed.

VT 24.png
Clients are also given the opportunity to schedule incoming backups by pressing the 'Schedule Backups' button.

Provide a time details to wait until the next backup is created.

VT 25.png
To restore a VPS from backup, simply press the 'Restore' button next to it.

If selected backups are no longer needed, you may easily delete them.

VT 26.png

Console

One of the most interesting functionality is a noVNC console where your clients can remotely manage their servers.
To access it, simply click on the 'Console' button.

Note: Vultr offers a generic VNC URL that serves as a white-label URL. If you wish to use a white-label console with the Vulr VPS For WHMCS module, please contact the Vultr support via their official ticketing system.

VT 33.png

Custom ISO

"Custom ISO" feature allows clients to pick a single ISO and mount it to the machine.

Note: Mounting a custom ISO requires rebooting the machine.

VT 36.png

Firewall

The firewall management page allows your customers to view, add, or delete existing rules on a security group assigned to the product.

To add a new firewall rule, use the button marked on the following screen.
Note: Please remember that there is a limit of 50 firewall rules. If you reach this limit, you will not be allowed to create new ones before removing any existing ones.

VT 27.png
Next, fill out the rule details to create it:
  • Type- choose between IPv4 andIPv6
  • Protocol - select among TCP, UDP, ICMP, GRE, ESP and AH
  • Port - you may specify a port number or a port range (TCP/UDP only)
  • Source: specify a custom source or cloudflare
  • Subnet and the Subnet Size
  • You may also add any Notes in the end if you need

Press 'Confirm' when ready.

VT 28.png

Graphs

Once entering the 'Graphs' section, clients will be moved to the page with the generated graphs showing the 'Bandwidth' usage.
VT 29.png


Reserved IP Addresses

This section includes a list of all existing in the panel reserved IP addresses.
  • on the account creations the IP addresses are automatically added to the group
  • on the change package action (downgrade/upgrade) the IPs are added or removed accordingly
  • on termination, all IPs are removed
VT 34.png

Reverse DNS

Reverse DNS option allows your clients to manage reverseDNS of the IP addresses assigned to the machine.

You can change the hostname that will appear when getting the hostname belonging to the primary IPs (IPv4 and IPv6) of your server.
To do so, just click on the button presented below.
Note: IPv4 addresses are already added on the list and cannot be deleted

VT 33 1.png
When 'IP' and 'Reverse DNS' are provided, just confirm the action.
VT 33 2.png
VT 33 3.png

Snapshots

Creating snapshots allows customers to quickly restore any changes to a virtual machine in case of any problems.

Once the shutter has been created, the customer can restore it (1), change its description (2) or delete it (3).

VT 31.png
After pressing the 'Create Snapshot' button, the new window will pop up along with the possibility to specify the snapshot description.

Please note that taking a new snapshot may take a while to process.

VT 32.png

User Data

User data can be freely altered in the client area. Remember that after introducing any changes, the machine restart is required to apply the changes.

Note: User data supports smarty variables, such as '{$password}'. Follow to this article to find a full list of supported module parameters and their descriptions.

VT 35.png

Tips

1. Vultr offers a generic VNC URL that serves as a white-label URL. If you wish to use a white-label console with the Vulr VPS For WHMCS module, please contact the Vultr support team via their official ticketing system.
2. If you may choose among all four configurable options to configure your VPS when placing an order, they will be prioritized in the following manner:

'Operating System' → 'Snapshot' → 'ISO' and 'Application' as the least one on the list.

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.

While upgrading to version 2.x make sure to follow those guidelines:

1. Make sure all tasks are finished, as the migration process will delete them.
2. Optionally, back up your customized language files.
3. Delete all files from the previous version of the module.
4. Upload the new module files.
5. Manually initiate the version upgrade with the cron command: 

php -q /YOUR_WHMCS/modules/servers/VultrVps/cron/cron.php upgrade run 2.0.0

6. Optionally, restore changes made to the language files.

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

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Downgrading virtual machines with block storage is impossible. Move to the official Vultr documentation to find out more.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Vultr_VPS_For_WHMCS&oldid=72734"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Vultr VPS For WHMCS