PUQ Mautic

Client Area

Everything the end customer sees in the WHMCS client area: VM overview with real-time status, noVNC console, performance charts, reinstall, snapshots, backups, password reset, reverse DNS, ISO mount and firewall management. Available features are controlled per product by the administrator.

Overview

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Overview page is the main management screen displayed when a client opens their Proxmox KVM service. It provides real-time VM status information, quick action buttons, and a complete network configuration summary.

Action Buttons

At the top of the page, action buttons allow the client to perform common operations:

Below the real-time information panel, additional management buttons provide access to:

The visibility of each button depends on the Client Area Permissions configured by the administrator for the product.

Information on Real Time

The overview displays live VM metrics that auto-refresh every 7 seconds:

Field Description
Status Current VM state (running / stopped) with uptime counter
CPU Current CPU utilization percentage and number of allocated cores
RAM Current memory usage with used/total values and a progress bar
System disk System disk size with R/W throughput (MB/s) and IOPS limits
Additional disk Additional disk size with R/W throughput (MB/s) and IOPS limits (if configured)
Network adapter Network adapter model, MAC address, and link speed

VM overview

Network Configuration

Below the real-time information panel, the network configuration section displays the complete networking setup for the VM:

An informational note reminds the client that only the main IP address is automatically configured on the network interface. Additional IP addresses must be configured manually inside the VM.

Network configuration

Disabled actions

When a feature is not permitted by the product's client-area permissions (or is temporarily unavailable — for example, during a backup or snapshot operation), the corresponding button stays visible but dimmed and is not clickable. This is intentional: the client can see the full list of features the product offers, even if specific ones are not allowed in their plan, and clearly understands the state of their VM while operations are in progress.

Changed in v3.0. Feature permissions have moved from the legacy configoption12 checkboxes to the new Bootstrap-based Client permissions panel in the product settings. All permission flags are preserved during upgrade, so the end-user behavior is identical to v2.x.

Navigation menu

Every sub-page in the client service area (Snapshots, Backups, Firewall, Reset password, revDNS, ISO, Charts, Reinstall) has a sidebar navigation menu that allows the client to jump between settings without going back to the overview each time.

Client area sidebar

If the client navigates directly to a page for a feature that the product does not allow, they see an Access Denied error message instead of the feature's UI. The Overview and noVNC buttons cannot be hidden — they are always available.

Error messages

The client area displays two common error messages:

noVNC Console

Proxmox KVM module WHMCS

Order now | Download | FAQ

The noVNC console provides browser-based remote access to the virtual machine's display, allowing clients to interact with their VM directly without requiring a separate VNC client application.

Accessing the Console

  1. Navigate to the service detail page and click the noVNC button in the action bar.
  2. A CONNECT button will appear along with a note indicating that the link is a one-time connection valid for 10 seconds.
  3. Click CONNECT to open the noVNC console in a new browser tab.

noVNC connect button

Connecting

After clicking the CONNECT button, a new browser tab opens and establishes a secure, encrypted WebSocket connection to the Proxmox VNC proxy. A status indicator in the console confirms the connection, showing the target QEMU VM identifier.

noVNC console connecting

Console View

Once connected, the full noVNC console is displayed, providing direct keyboard and mouse interaction with the VM. The console toolbar on the left side provides additional controls for clipboard, screen scaling, and connection settings.

noVNC console connected

Important Notes

Charts

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Charts page provides visual performance graphs showing resource utilization of the virtual machine over time. Data is sourced from Proxmox VE RRD (Round Robin Database) statistics and rendered using the Google Charts library.

Available Charts

The page displays four resource usage graphs:

Chart Description
CPU Usage Processor utilization as a percentage of allocated cores over time
RAM Usage Memory consumption showing used vs. available RAM
Disk I/O Usage Disk read and write throughput, displayed as separate Read MB/s and Write MB/s lines
Network Usage Network traffic volume with separate lines for inbound (In MB/s) and outbound (Out MB/s) traffic

Time Period Tabs

Charts can be viewed across different time ranges using the tab buttons at the top of the page:

Clicking a tab reloads all four charts with data for the selected time period.

Charts usage

Notes

Reinstall

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Reinstall page allows clients to reinstall the operating system on their virtual machine. This is a destructive operation that replaces the current OS with a fresh installation from the selected template.

Process

  1. Navigate to the service and click Reinstall in the sidebar or from the action buttons on the overview page.
  2. A warning is displayed: reinstalling will completely remove all data on all disks of the virtual machine, and all snapshots will also be deleted.
  3. Select the desired operating system from the Select operating system dropdown. The available options are configured by the administrator in the product settings.
  4. To protect against accidental reinstallation, type the word REINSTALL in the confirmation field.
  5. Click the Reinstall button to begin the process.

Reinstall page

What Happens During Reinstall

Backups survive a reinstall. The reinstall procedure explicitly deletes only the VM's disks and snapshots — any existing backup archives are kept intact. This gives you a safety net: even after reinstalling a brand-new OS, you can still restore a previous backup to return to the pre-reinstall state. Use this carefully.

Important Notes

Snapshots

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Snapshots page allows clients to create, rollback, and remove point-in-time snapshots of their virtual machine. Snapshots capture the complete state of the VM, including disk contents and memory (if running), enabling quick recovery to a known good state.

Snapshots are not backups. They are intended as a quick safety net during system administration work (package updates, config changes, etc.) — that's why their lifetime is enforced and limited (1–10 days). For long-term data protection use the Backups feature instead.

Snapshot Quota

The snapshot quota is displayed at the top of the page as a counter (e.g., 2/3), showing the number of existing snapshots out of the maximum allowed. The quota limit is configured by the administrator in the product settings.

Creating a Snapshot

  1. Navigate to the service and click Snapshots in the sidebar.
  2. Optionally enter a description in the Snapshot description text field.
  3. Click the Take Snapshot button.
  4. The snapshot is created in the background. Once complete, it appears in the list below.

Managing Snapshots

Each snapshot in the list displays:

For each snapshot, two actions are available:

Snapshots page

Snapshot Lifetime

Snapshots have a configurable lifetime set by the administrator in the product settings. When the lifetime expires, the snapshot is automatically removed by the cron system. The remaining lifetime for each snapshot is displayed in the snapshot list.

Important Notes

Backups

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Backups page provides full VM backup management, including scheduled automatic backups, manual on-demand backups, restore from backup, and backup removal.

Scheduled Automatic Backups

The top section of the page displays the backup schedule configuration with a day-of-week grid. For each day of the week (Sunday through Saturday), the client can:

After configuring the schedule, click Save Schedule to apply the changes. When a schedule is configured, the system will automatically create backups at the specified times and delete old backups that exceed the retention quota.

An informational note confirms: "If the schedule is configured, the system will automatically create backups and delete old backups."

Backup Quota

The backup quota is displayed as a counter next to the Backups heading (e.g., 1/10), showing the number of existing backups out of the maximum allowed. The quota limit is configured by the administrator in the product settings.

Creating a Manual Backup

  1. Optionally enter a note in the Backups notes text field to identify the backup.
  2. Click the Backup now button.
  3. The backup task is submitted to Proxmox and runs in the background. Progress is monitored by the WHMCS cron system.

Backup List

Each backup in the list displays:

For each backup, two actions are available:

A warning note reminds the client: "In the case of a backup restore, all snapshots of Virtual Machine will be deleted."

Backups page

How scheduled backups run

On each cron tick the backup task:

  1. Checks which VMs have the current weekday enabled in their schedule.
  2. Checks whether the configured time-of-day for today is already in the past (so that the job runs once per day, not repeatedly).
  3. Checks whether today's backup already exists — if yes, skips.
  4. Checks whether there is a free backup slot. If the quota is full, the oldest backup is deleted first to make room.
  5. Creates the new backup and monitors the Proxmox task until completion.

Backup restoration

Before a backup is restored, the VM must be in a powered off state. After a successful restore the module automatically re-applies the current package parameters to the restored VM:

  1. Set CPU & RAM if different from the restored values
  2. Resize system disk if different
  3. Re-apply system disk bandwidth limits
  4. Create additional disk if needed
  5. Resize additional disk if needed
  6. Re-apply additional disk bandwidth limits
  7. Re-apply network configuration (bridge, VLAN, bandwidth, MAC)
  8. Start the VM
  9. Send the Backup restored email to the client

If the restore fails for any reason, the client is given the option to retry the restore or to reinstall the virtual machine from scratch.

Important Notes

Reset Password

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Reset Password page allows clients to generate a new root/admin password for their virtual machine. The new password is applied via cloud-init and sent to the client by email.

Process

  1. Navigate to the service and click Reset password in the sidebar.
  2. Review the informational note about cloud-init requirements.
  3. Click the Reset Password button.
  4. A new password is automatically generated by the system.
  5. Cloud-init applies the new password to the VM.
  6. The new password is sent to the client via the configured email template.

Reset password page

Cloud-Init Requirement

An informational note on the page states: "Password reset requires cloud-init packages installed on the VM. If reset succeeds but password doesn't change, connect via noVNC and change manually."

This means:

Important Notes

Changed in v3.0. The password reset flow now works on a running VM via cloud-init (and the QEMU guest agent if installed) — the client does not need to stop the VM first. In v2.x and earlier, the client had to manually power off the VM before resetting the password; the module then generated the new password, rewrote cloud-init and started the VM back up. If you are documenting behaviour for clients running an older version, keep that difference in mind.

Reverse DNS

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Reverse DNS page allows clients to configure PTR (pointer) records for all IP addresses assigned to their virtual machine. Reverse DNS records map IP addresses back to hostnames and are commonly required for mail servers and other services that perform reverse lookups.

Configuration

  1. Navigate to the service and click revDNS configure in the sidebar.
  2. Each IP address assigned to the VM (both IPv4 and IPv6) is listed with an editable hostname field.
  3. Enter the desired hostname for each IP address.
  4. Click the Save button to apply the changes.

The page lists all assigned addresses, including:

Each address has its own hostname input field, allowing independent reverse DNS configuration per IP.

Reverse DNS page

DNS Propagation

An informational note at the top of the page states: "DNS changes take 1-8 hours to propagate across servers."

After saving, the reverse DNS records are automatically synchronized with the configured DNS provider (Cloudflare or HestiaCP, as configured in the addon module). However, due to DNS caching and propagation across the internet, the changes may not be visible to all resolvers immediately.

Important Notes

Ticket-based fallback

Still supported for operators without a DNS API. If your reverse-DNS infrastructure does not expose an API (neither Cloudflare, HestiaCP nor PowerDNS), the module can fall back to opening a WHMCS ticket when the client requests a revDNS change — you then apply the change by hand on your DNS server.

This is configured in the product settings under Integrations → Revdns ticket / RevDNS ticket department. When a ticket department is selected, saving the reverse-DNS form creates a new WHMCS ticket in that department with the requested IP→hostname mapping instead of calling the DNS provider.

Changed in v3.0. With the PowerDNS provider added alongside Cloudflare and HestiaCP, most deployments can now use the automatic path and do not need the ticket fallback any more. The ticket mode is still available for mixed setups or for operators who deliberately want manual approval of every PTR change.

ISO Mount

Proxmox KVM module WHMCS

Order now | Download | FAQ

The ISO Mount page allows clients to mount and unmount ISO images on their virtual machine's virtual CD/DVD drive. ISO images are organized into categorized folders for easy browsing.

Currently Mounted ISO

If an ISO image is currently mounted, it is displayed at the top of the page with a highlighted status bar showing the filename (e.g., "Mounted: alpine-standard-3.21.3-x86_64.iso") and an Unmount button to eject it.

Browsing Available ISOs

ISO images are organized into folders by category. Each folder displays:

Inside each folder, individual ISO files are listed with their full filename and a Mount button.

How the categorization works

To keep the ISO list readable the module derives the folder name from the part of the filename before the first - character:

Follow this convention when uploading ISOs to your Proxmox ISO storage. PUQcloud publishes a set of pre-built ISO images that are named in this convention and ready to use — see the ISO storage on files.puqcloud.com.

Mounting an ISO

  1. Navigate to the service and click ISO mount in the sidebar.
  2. Browse the available ISO folders to find the desired image.
  3. Click the Mount button next to the ISO file.
  4. The ISO is attached to the VM's virtual CD/DVD drive and becomes available for booting or installation.

Unmounting an ISO

  1. Locate the currently mounted ISO at the top of the page.
  2. Click the Unmount button.
  3. The ISO is ejected from the virtual CD/DVD drive.

ISO mount page

Use Cases

Important Notes

Firewall

Proxmox KVM module WHMCS

Order now | Download | FAQ

The Firewall page provides clients with full control over their virtual machine's Proxmox firewall, including default policies and individual traffic rules.

Firewall Policies

At the top of the page, two default policies can be configured:

After selecting the desired policy values from the dropdown menus, click the Save button to apply them. These policies determine what happens to traffic that does not match any specific rule.

Firewall Rules

Below the policies section, the rules table displays all configured firewall rules. The rule count is shown as a badge next to the heading (e.g., 4).

Rules Table Columns

Column Description
# Rule position number (determines evaluation order)
Dir Traffic direction: IN (inbound) or OUT (outbound)
Action What to do with matching traffic: ACCEPT (allow, shown in green) or DROP (block, shown in red)
Proto Protocol filter (e.g., tcp, udp, any)
Source Source IP address or network (or "any" for all sources)
S.Port Source port or port range (or "any" for all ports)
Dest Destination IP address or network (or "any" for all destinations)
D.Port Destination port or port range (or "any" for all ports)
Comment Optional description of the rule's purpose

Adding a Rule

Click the + Add Rule button to open the rule creation modal. Fill in the rule parameters (direction, action, protocol, source, destination, ports, and comment) and save.

Reordering Rules

Rules are evaluated in order from top to bottom. The drag handle (grid icon) on the left side of each rule row allows drag-and-drop reordering. Drag a rule up or down to change its evaluation priority. The first matching rule determines the action taken on the traffic.

Deleting a Rule

Click the red delete button on the right side of a rule row to remove it. The rule is deleted immediately.

Firewall rules page

How Rules Are Evaluated

  1. Incoming or outgoing traffic is checked against the rules in order, starting from rule #0.
  2. The first rule that matches the traffic's direction, protocol, source, destination, and ports determines the action (ACCEPT or DROP).
  3. If no rule matches, the default policy (Input Policy or Output Policy) is applied.

Important Notes