Skip to main content 
Product Configuration
Order now | Dowload | FAQ
Add new product to WHMCS
System Settings->Products/Services->Create a New ProductIn the Module settings section, select the "PUQ ProxmoxKVM" module
License key
A pre-purchased license key for the "PUQ ProxmoxKVM" module. For the module to work correctly, the key must be active
Type of virtual machine creation
How will the virtual machine will be cloned from the template
Full Clone - much more times for deployment.
Linked clone VM - faster deployment, requires less disk space but cannot run without access to the base VM Template
Target node
The node in the cluster on which the virtual machine should be created. If you select the automatic option or the node was unavailable at the time the virtual machine was created, the module will actually select the node with the most real free RAM (not a percentage, but the most free RAM numerically).
If a specific node is selected manually, the module does not check the available RAM in any way.
Default OS template
Sets the default operating system template. In cases where the template chosen by the client is not available, or if the options with the choice of the operating system are not configured, this template will be used.
Backups storage
Data store for backups of virtual machines
If you are using a cluster, then you need to have this data store on a network protocol, such as NFS.
ISO's storage
Data store for ISO images
If you are using a cluster, then you need to have this data store on a network protocol, such as NFS.
VM configuration
Basic configuration settings for the virtual machine
CPU - number of CPU cores for a new machine
RAM - amount of RAM for a new machine
OS username - The user that will be configured in the virtual machine settings will be transferred to the client and will appear in the password change
Depending on cloud-init settings in the template. If there is a root user in the template and you also enter root in the service configuration in WHMCS, a password for the root user will be generated when creating the VM. If you enter another user name in this window (but the template does not contain one), it will be created when the machine is created and the password will be sent to the client.
VM name prefix: The VM name prefix will be added to the virtual machine name.
VM name: <prefix>-<client_id>-<service_id>
First vm id: ID from which to start searching for a free id for a new virtual machine
Snapshot lifetime: After how many days will snapshots be removed automatically
System disk
The system disk is determined by the one that is assigned to the first boot in the virtual machine or template.
System disk options. The system drive is the drive on which the system is installed. Limitations are possible both in terms of bandwidth in megabytes per second, as well as restrictions on the number of I/O operations.
Please note that the size of the system disk must be greater than or equal to the size of the system disk in the template.
Additional disk
The additional drive is the second drive in the virtual machine or template that is not assigned to the first boot option.
If an additional disk is not created in the virtual machine template, it will be created automatically on the same storage as the system disk. If you need an additional disk on a different storage than the system disk, it must be then created in the virtual machine template on the required storage.
Additional disk options. Limitations are possible both in terms of bandwidth in megabytes per second, as well as restrictions on the number of I/O operations.
Network configuration
The section in which you must specify the parameters of the network virtual machine map.
Network model - The network card model of the virtual machine
Automatic selection bridge/VLAN -When creating a virtual machine, the IP address will be selected automatically from the list of available IP addresses from the PROXMOX server parameter or IP Pools added in the WHMCS system. Regarding the selected IP address, the network card, bridge and vlan will be configured.
Network bridge, VLAN - If you do not use the Automatic selection, bridge/VLAN. You need to select bridge and VLAN. The IP address will be selected from the list of IP addresses available in this bridge and VLAN in the PROXMOX server address list settings in the WHMCS system.
DHCP IPv4 - Whether to use a DHCP server. The IP address will not be selected from the list in the PROXMOX server in the WHMCS system. In this case, firewall rules won't be applied as we don't know IP address.
DHCP IPv6 - Whether to use a DHCP server. The IP address will not be selected from the list in the PROXMOX server in the WHMCS system. In this case, firewall rules won't be applied as we don't know IP address.
Firewall - Enable firewall on the network card of the virtual machine. Only works when DHCP is not used.
Anti spoofing rules - This option only works if you are not using a DHCP server. It adds allowing rules for incoming and outgoing traffic with the IP address of the virtual machine.
For the correct operation of the firewall rules to avoid spoofing the IP address of the virtual machine, it is necessary to configure the firewall on the PROXMOX server, the firewall policy DENY/DENY.
In order to manage pools of IPv4 and IPv6 IP addresses, you need to install the PUQ Customization addon module (free)
https://doc.puq.info/books/puq-customization-whmcs-addon
https://download.puqcloud.com/WHMCS/addons/PUQ-Customization/
https://puqcloud.com/whmcs-addon-puq-customization.php
Integrations configuration
This section contains settings that are responsible for integrating the module with other systems.
noVNC WEB proxy server, noVNC WEB proxy key - VNCPROXY server settings.
VNCPROXY and noVNC are used to enable the client to connect to the virtual machine console (Keyboard, Video, Mouse).
How to set up a VNCPROXY server is described in https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/install-vncproxy-and-novnc
For your comfort we provide our public VNCPROXY server with noVNC client. You can use it freely, but we strongly recommend creating your own VNCPROXY server with noVNC client
noVNC WEB proxy server: vncproxy.puqcloud.com
noVNC WEB proxy key: puqcloud
Main domain - The domain that you use to present the virtual machine. In the WHMCS system, the domain column on the client's product will be filled in the format <prefix>-<client_id>-<service_id>.<Main domain>. Also, this parameter will be specified as "search" in the virtual machine in the /etc/resolv.conf file.
Revdns ticket/RevDNS ticket department - In case you haven't created a reverse DNS zone record integration. The module can create a ticket when the client changes the reverse zone entry in the settings. You will have to manually process the request.
How you can integrate DNS zone records with your DNS server is described here: https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/synchronization-of-dns-records
Email configuration
In this section, you need to select email templates that will be used by the module to communicate with the client.
VM is ready - This email will be sent each time a virtual machine is created. In case of creation and in case of reinstallation. In this email, the client will receive a login and password to access the virtual machine system.
Reset password - This email will be sent to the client every time the client uses the password reset function, the client will receive a login and password to access the virtual machine system.
Backup restored - This email will be sent to the client every time the client uses the restore virtual machine from backup function.
Sample templates are available here:
https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/email-template-puqproxmoxkvm-vm-is-ready
https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/email-template-puqproxmoxkvm-reset-password
https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/email-template-puqproxmoxkvm-backup-restored
Additionally:
https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/email-template-puqproxmoxvkm-welcome-email
https://doc.puq.info/books/proxmoxkvm-whmcs-module/page/email-template-puqproxmoxkvm-upgrade-email
Client configuration
In this section, you can configure the client's access rights to manage its virtual machine.
No Comments