VPS.Net - Revision history

SarahK at 20:16, 7 April 2022

2022-04-07T20:16:31Z

SarahK: /* Setup/Configuration */

2020-08-04T16:52:28Z

‎Setup/Configuration

Lawrence: /* Method 2: Let the User Choose */

2020-06-30T13:20:46Z

‎Method 2: Let the User Choose

Lawrence: /* Method 2: Let the User Choose */

2020-06-30T13:19:43Z

‎Method 2: Let the User Choose

Lawrence: /* Client Area Management Options */

2020-06-16T13:06:59Z

‎Client Area Management Options

Lawrence: /* Client Area Management Options */

2020-06-16T12:59:19Z

‎Client Area Management Options

Lawrence: /* Admin Area Management Options */

2020-06-16T12:55:26Z

‎Admin Area Management Options

Lawrence: /* Setup/Configuration */

2020-06-16T12:33:37Z

‎Setup/Configuration

Lawrence: /* Setup/Configuration */

2020-06-16T12:10:41Z

‎Setup/Configuration

Lawrence: /* Setup/Configuration */

2020-06-16T11:57:35Z

‎Setup/Configuration

@@ Line 1: / Line 1: @@
 {{Provisioning_Module
 | changepackage = Yes
 | clientarealink = Yes
-| additional = Start, Shutdown and Reboot VPS, Bandwidth & CPU Graphs and Enable & Disable Backups}}
+| additional = Start, Shutdown and Reboot VPS, Bandwidth & CPU Graphs and Enable and Disable Backups}}
-This is the first official module, not to be confused with previous third party modules for the VPS.Net service.
+== Adding a VPS.net Server ==
-==Setup/Configuration==
+To set up a VPS.net server in WHMCS:
-#The first step is to create a server in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
+=== Creating a VPS.net Product ===
-#* Server name: Set to anything you like,
-#* Hostname: VPS.Net
+You can create a product that provisions accounts on your VPS.net server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.  When you do this, select the '''Server/VPS''' product type.
-[[File:Vpsnetmodulesettingsrevised.png]]
+You can create products using two methods:
-===Method 1: Fixed Products===
+==== Fixed Products ====
-With this method, you would set the number of nodes you want this product to come with and the Cloud/Template on the Module Settings page itself so the user doesn't get a choice. For example you could set the number of nodes to 2, the cloud/template to "London Zone A - CentOS Optimized" as above and then a monthly price on the pricing tab.  You could do this for each configuration of VPS you want to offer and thus have a seperate product for each.
+To create products with fixed options that customers cannot change when ordering, set the number of nodes for the product and the Cloud/Template within the '''Module Settings''' tab.
-===Method 2: Let the User Choose===
+* For example, this could set the number of nodes to 2, the Cloud/Template to "London Zone A - CentOS Optimized", and a monthly price on the pricing tab.
-Alternatively, the Number of Nodes and Cloud/Template options you want to offer can also be provided to the user on the signup form as '''Configurable Options''' through a single product. This allows the user to choose exactly what they want and see the price updated based on their selections.  Setup of this method involves setting the base product price to zero, and then creating a [[Addons_and_Configurable_Options#Configurable_Options|Configurable Options Group]] which supports the following option names:
+==== Custom Products ====
-*'''Nodes''' - Can be a Quantity, Dropdown or Radio Selection option type to allow the user to specify the number of nodes they want. Should be a numeric value.
+[[File:vpsnetconfigoptionnodes.png|thumbnail]]
-*'''Cloud Template''' - Can be a Dropdown or Radio Selection option type to allow the user to choose the Cloud Location and OS Template they desire. Should be in the format CloudID+TemplateID - you can find the ID values on the Module Settings tab Cloud Template dropdown for the module.
+[[File:vpsnetconfigoptiontemplatelocation.png|thumbnail]]
-*'''Enable Backups''' - Can be a Yes/No option type to allow the user to choose if they want backups ability. There are also 3 options you can use for the different backup options; "Enable Backups", "Rsync Backups" & "R1Soft Backups".
+[[File:vpsnetconfigoptionsorder.png|thumbnail]]
-The below screenshots show an example of how the configurable options could be setup:
+To create products with custom options that customers can change when ordering, use configurable options.
-[[File:vpsnetconfigoptionnodes.png]]
+To create this type of product, set the base product price to <tt>0</tt> and create a [[Addons_and_Configurable_Options#Configurable_Options|configurable options group]] that supports the following option names:
-[[File:vpsnetconfigoptiontemplatelocation.png]]
+* '''Nodes''' — A ''Quantity'', ''Dropdown'', or ''Radio Selection'' option type that allows the user to specify the number of nodes they want.
-[[File:vpsnetconfigoptionsorder.png]]
+=== Customisation ===
-The important feature of config options to remember is the field format "'''SystemValue|DisplayValue'''" for flexibility ie. the part before the pipe symbol is what the system requires and the part after is what you want to display to users and can be more friendly.  This is demonstrated in the example above.
+You can customize the following template files:
-==Upgrades/Downgrades==
+* <tt>cpugraphs.tpl</tt>
-Automated product & configurable option upgrades/downgrades are fully supported by the VPS.Net module so if enabled in the product configuration, WHMCS will allow the user to order a change of their VPS Product, or number of nodes/cloud template/backups options and automatically provision it with VPS.Net upon payment.
+You can also customize language file lines that appear in the Client Area.
-==Admin Area Management Options==
+== Client Area Management ==
-The admin area allows for creation & termination of VPS.Net services along with automated package changes, power management, and backup generation as shown in the Module Commands below. The VPS Hostname & IP will also be displayed in the respective fields for the product.
+[[File:Vpsnetclientarearevised1.png|thumbnail]]
-[[File:Vpsnetadminsiderevised1.png]]
+The Client Area allows VPS.net clients to perform the following actions directly:
-==Client Area Management Options==
+* Boot, reboot, and shut down the VPS.
-The client area with this module provides clients with an automated management panel for their VPS service all without any admin/staff intervention. This includes the ability to:
+=== WHMCS Connect ===
-*Power On, Off, Reboot & Shutdown their VPS
+This module does not support [[WHMCS Connect]].
-[[File:Vpsnetclientarearevised1.png]]
+==Troubleshooting==
-==Customisation==
+''N/A''
 {{modules}}

@@ Line 10: / Line 10: @@
 ==Setup/Configuration==
-#The first step is to create a server in '''Setup > Products/Services > Servers'''.
+#The first step is to create a server in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
 #* Server name: Set to anything you like,
 #* Hostname: VPS.Net
@@ Line 22: / Line 22: @@
 #*On the page that appears, click the '''Generate''' link next to the API key field.
 #Once the server has been setup, you can then proceed to create your first product. The basic steps for this are:
-#*Begin by going to '''Setup > Products/Services > Products/Services'''
+#*Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
 #*Click the '''Create a New Product''' link
 #*Select '''VPS/Dedicated Server''' for the Product Type
@@ Line 41: / Line 41: @@
 *'''Nodes''' - Can be a Quantity, Dropdown or Radio Selection option type to allow the user to specify the number of nodes they want. Should be a numeric value.
-*'''Cloud Template''' - Can be a Dropdown or Radio Selection option type to allow the user to choose the Cloud Location & OS Template they desire. Should be in the format CloudID+TemplateID - you can find the ID values on the Module Settings tab Cloud Template dropdown for the module.
+*'''Cloud Template''' - Can be a Dropdown or Radio Selection option type to allow the user to choose the Cloud Location and OS Template they desire. Should be in the format CloudID+TemplateID - you can find the ID values on the Module Settings tab Cloud Template dropdown for the module.
 *'''Enable Backups''' - Can be a Yes/No option type to allow the user to choose if they want backups ability. There are also 3 options you can use for the different backup options; "Enable Backups", "Rsync Backups" & "R1Soft Backups".

@@ Line 47: / Line 47: @@
 [[File:vpsnetconfigoptionnodes.png]]
 [[File:vpsnetconfigoptiontemplatelocation.png]]
 [[File:vpsnetconfigoptionsorder.png]]

@@ Line 46: / Line 46: @@
 The below screenshots show an example of how the configurable options could be setup:
-[[File:Vpsnetconfigoptions.png]]
+[[File:vpsnetconfigoptionnodes.png]]
 The important feature of config options to remember is the field format "'''SystemValue|DisplayValue'''" for flexibility ie. the part before the pipe symbol is what the system requires and the part after is what you want to display to users and can be more friendly.  This is demonstrated in the example above.

@@ Line 68: / Line 68: @@
 *Generate Backups & Restore Previous Backups
-[[File:Vpsnetclientarearevised.png]]
+[[File:Vpsnetclientarearevised1.png]]
 ==Customisation==

@@ Line 30: / Line 30: @@
 #*You will then see a screen like the one below where you can enter the Number of Nodes, select the Cloud/Template for this item, and enable/disable Backups aswell as choosing the desired auto setup option.
-[[File:Vpsnetmodulesettings.png]]
+[[File:Vpsnetmodulesettingsrevised.png]]
 ===Method 1: Fixed Products===

@@ Line 25: / Line 25: @@
 #*Click the '''Create a New Product''' link
 #*Select '''VPS/Dedicated Server''' for the Product Type
-#*Choose the appropriate product group and give the product a name, then click '''Continue >>'''[[File:Vpsnetproductsetup.png]]
+#*Choose the appropriate product group and give the product a name, then click '''Continue >>'''[[File:Vpsnetproductsetuprevised.png]]
 #*On the next screen that appears, all settings can be left at their defaults
 #*Next move to the '''Module Settings''' tab and select the '''Vpsnet''' module from the dropdown menu. Server Group should be left at '''None'''.