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.

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

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

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

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

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

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

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

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.

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

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.

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

Click on 'Create a New Group' .

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

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

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

• Region - choose one of the geographical areas with the preferred predefined set of resources for your VPS.
  
• Plan - choose a plan to install the virtual machine.
• Default Reverse DNS Template - define the default format for reverse DNS entries using supported Smarty variables to represent parts of the IP address.
• Random Domain Prefix - enter the domain prefix that will be used when a domain is not provided.
• Automatic Backups - turn on automatic backups creation.
• IPv6 Support - 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.
• DDOS Protection - add an extra layer of security by enabling DDOS protection.
• 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, see the applications section.

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

• Block Storage - Enable Block Storage.
  Important: It is impossible to successfully downgrade block storage.
• Storage Type - Select Block Storage type.
• Storage Size - 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.
• Snapshot Limit - define the snapshot limit that the client is allowed to create.
• Reserved IP Addresses - enable reserved IP addresses feature.
• IPv4 Addresses Limit - enter the limit of addresses for IPv4.
• IPv4 Addresses Limit - enter the limit of addresses for IPv6.

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.

We recommend using either block_storage or a combination of block_storage_size and block_storage_type, but not both at the same time, as they serve the same purpose in different ways.
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.

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.

It includes a task 'Queue' for managing pending actions, a 'Logs' section for tracking activity, and 'App Templates' for preparing applications for clients.
Additionally, the media library allows for the easy upload of images to be used within the module.

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

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

• Task ID
• Job
• Queue
• Retry Count
• Parent ID
• Type
• Related Item
• Custom Relation
• Status
• Retry After Date
• Created At Date
• Updated At Date

• Auto Prune - enable or disable the auto prune system, which will automatically delete tasks after a specified time.
• Auto Prune Older Than - specify the time period for auto prune system, tasks older than provided number of days will be deleted.
• Display 'Cron Job Configuration' Hint - display or hide the 'Cron Job Configuration' hint at the top of the page.

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' in the client area.

You can change the settings and have the guide collapsed by default. Clicking on the 'Additional Actions' button, select 'Options' and 'Collapse Guide'.

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

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

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

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

See the examples below to learn about the most important options.

1. Navigate to 'App Templates' → 'Applications' and click on 'Create'.

See the official official Vultr documentation too learn how.
Make sure to include your API Key, the request looks like this:

curl "https://api.vultr.com/v2/applications" \
 -X GET \
 -H "Authorization: Bearer ${VULTR_API_KEY}"

Example result:

{
"applications": [
{
"id": 1,
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"type": "one-click",
"vendor": "vultr",
"image_id": ""
}

For example 'LEMP' from:

"name": "LEMP",

Note: If you include a 'name' setting detail (see step 4) with the name from the request as its value, you can safely rename the application to something else here.

In our case it is:

"id": 1,

If an application supports scripts, the responsible setting will always be added automatically.
To include a script, edit the setting by clicking on the 'Edit' button next to it.

• Name - do not change this value, this is the setting identifier.
• Field Type - if the 'Visibility' setting is toggled on, this field decides the type of field, we recommend leaving it as is.
• Default Value - this is where you include your script. If 'Visibility' is toggled on, this will be the default value that clients can modify.
  Note: Use the merge field list on the right for reference.
• Validation - optionally, provide Laravel validation rules like 'required'.
• Visibility - this will allow the client to modify the script before installation.

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

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

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.

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

• Critical
• Error
• Notice
• All (Total)

• Logging Settings
• Log Export
• Rule Based Deletion

• Log Types - Specify which types of logs should be recorded.
• Clear Automatically - Choose whether to automatically delete logs older than a defined number of days.
• Delete Logs Older Than - Define the number of days after which logs will be automatically deleted.

• From - Define the starting date for logs to export.
• To - Define the ending date for logs to export.
• Log Types - Includes 'Notice', 'Error' and 'Critical' log types.

• Log Types - Specify which log types should be considered for removal.
• Delete Logs Older Than - Define the number of days after the log occurrence for automatic deletion.

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).
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.
8. Applications list allowing for machine reinstallation with included applications or systems.

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.

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

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

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

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.

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

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

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.

Note: Mounting a custom ISO requires rebooting the machine.

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.

• Type- choose between 'IPv4' and 'IPv6'.
• 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 - enter the source IP address.
• Subnet Size - define the size of the subnet.
• Notes - include custom notes if needed.

Press 'Confirm' when ready.

• 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

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

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

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

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.

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

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.

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.

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.