Proxmox VE for WHMCS

Proxmox VE for WHMCS

Developed By LEOPARD.host (by TNC)

Compatible with WHMCS v8.7

Proxmox VE for WHMCS (Module) Provision & Manage Guests on PVE Nodes/Clusters

  • Configure VM/CT plans with custom CPU/RAM/VLAN/On-boot/Bandwidth/etc
  • Automatically Provision VMs & CTs in Proxmox VE from WHMCS easily
  • Allow clients to view/manage VMs using the WHMCS Client Area
  • Create/Suspend/Unsuspend/Terminate via WHMCS Admin Area
  • Statistics/Graphing is available in the Client Area for services :)

System Requirements

  • (WHMCS) v8.x.x stable (HTTPS)
  • (WHMCS) Service ID above 100
  • (PHP) v8.x.x (stable version)
  • (Proxmox) VE v7/8 (current)
  • (Proxmox) 2 users (API/VNC)

SID >100: The WHMCS Service ID requirement is CRITICAL, as Proxmox reserves VMIDs <100 (system).

If you don't have enough services (of any status) in WHMCS (DB: tblhosting.id), create enough dummy/test entries to reach Service ID 101+. Else you're likely to see an error which explains this: HTTP/1.1 400 Parameter verification failed. (invalid format - value does not look like a valid VM ID)

Installing & Configuring the Module

Once you have uploaded, activated and made the WHMCS Module available to Administrators, you need to:

  1. WHMCS Admin > Addons > Proxmox VE for WHMCS > Module Config > VNC Secret (see below)
  2. WHMCS Admin > Addons > Proxmox VE for WHMCS > Add KVM/LXC Plan/s
  3. WHMCS Admin > Addons > Proxmox VE for WHMCS > Add an IP Pool
  4. WHMCS Admin > Config > Products/Services > New Service (create offering)
  5. " " > Newly-added Service > Tab 3 > SAVE (associates Plan/Pool to WHMCS Service type)

For now, please use the Manual PDFs as supplementary information, re: ISO files, LXC templates, etc. This is out-dated though still helpful contextually - please read the note at the top of this README.

Module Technical Support

Wiki: https://github.com/The-Network-Crew/Proxmox-VE-for-WHMCS/wiki

Including logs, details, steps to reproduce, etc, please raise an Issue.

Information we will need, at a minimum:

  • (PHP) error_log contents
  • (WHMCS) Module Debug Log contents
  • (Configs) WHMCS/PHP/Module/Proxmox/etc
  • (PVE) Logs from Proxmox Host (pveproxy etc)
  • (Reproduction) pvesh/etc variants of failing calls

Please note that this is FOSS and Support is not guaranteed.

This module is licensed via the GNU General Public License v3.0.

Updating the Addon Module

WHMCS Admin > Addon Modules > Proxmox VE for WHMCS > Support/Health shows updates.

You can download the new version and upload it over the top, then run any SQL ops.

Please consult the SQL.md file, open your WHMCS DB & run the statements. Then you're done.

Contributing to the Module

If you'd like to contribute to the Module, please open a PR.

Learn more about TNC & Co.

The Network Crew Pty Ltd

LEOPARD.host

 

Reviews

5 stars
4
4
4 stars
0
0
3 stars
0
0
2 stars
0
0
1 star
1
1

chairul anwar @chairul9768

August 11, 2023 at 10:32:06 AM

I have managed to install this module even though there are lots of errors. but I have managed to fix it. I hope that the PROXMOX VE FOR WHMCS Free project will continue and get even better. and for developers keep the spirit

Thank You

  • 1 month ago
  • Version Number 1.2.1
  • Edited

Willi @willi7464

June 21, 2023 at 08:38:37 PM

Hi colles Addon for WHMCS,

my Question Would the configurator from WHMCS also work if so what do I have to set.

  • 3 months ago
  • Version Number 1.2.1

Fabian Ruhl @fabian1776

June 16, 2023 at 06:56:54 AM

No comment provided.

  • 3 months ago
  • Version Number 1.1

Andrei Kostas @8757

June 15, 2023 at 04:15:55 PM

The module does not work correctly, too many errors, so do not be too happy that it is free.

Luke Thompson @luke3603

June 16, 2023 at 02:03:02 AM

The current v1.1 release is a beta, and is the first step in resolving issues arising from the 7-year delta.

We have forked the module and continue to overhaul it. Version 1.2 will address many of the problems.

FOSS (Free Open-source Software) projects die out due to such abuse. You are only negatively contributing.

This is all explained on the repository. Due to your review, we have now added a Zero-tolerance Abuse line too.

Owner@LEOPARD.host (by TNC)  
  • 3 months ago
  • Version Number 1.1

Alexandre dos Santos @alexandre5881

June 10, 2023 at 07:29:39 AM

Sorry, is free or not?

Step6: Enter license key which you obtained from www.moduleland.com, and save License.

This site are offline.

Thanks.

Luke Thompson @luke3603

June 16, 2023 at 02:00:43 AM

Hi there Alexandre, thanks for your 5-star review!

The module is free, however the original Manual PDF files in the repository are outdated, and show the previous license steps.

Version 1.2 is due to be released in the next few days, it resolved many small bugs and issues in the 7 year delta.

Once you've made the update after its release, please let us know via GitHub Issues of problems.

Owner@LEOPARD.host (by TNC)  
  • 3 months ago
  • Version Number 1.1

Version Compatibility


Compatible with WHMCS v8.7

Full Version Compatibility


  • Selected versions of WHMCS v8.7
        8.7.2

Support for this product

The best place to start if you need help with a specific product is to contact the developer. All WHMCS Marketplace developers have both a website and support URL listed.

Developed By LEOPARD.host (by TNC)

Changelog

v1.2.2 Released September 15th, 2023

Latest Version


Feature

  • Debugging Mode: Allow admin to turn on/off Module Log feed (#38)*
  • VLAN ID: Set the required Virtual LAN ID against VM/CT Plan (#35)*
  • Version: Report in-use & latest versions in Health; ver alert (#21)
  • Power Actions: Now available in Admin Area as well as Client Area
  • (Note: Suspend/Unsuspend/Terminate remain admin-only functions)

Polish

  • Client Area: Power Action wording amended (Soft Stop, Hard Stop)
  • Admin, Module Config: Explain what the VNC Secret field is about
  • Admin, Module Config: House-keeping to design, Support/Health tab

Bug Fix

  • Admin, Create Service: Fails if Plan/Pool not assigned in WHMCS (#36)
  • Client, VNC: Fails early if VNC Secret is not set or adequate (#27)
  • On-boot Status: Enabled/Disabled now properly applied for CTs (#34)

(*): SQL Note: There are new columns in 2 of the module tables, see SQL.md

 

Previous Versions


v1.2.1 Released June 19th, 2023

View/hide detailed changelog

Feature

  • Module Config tab, allowing for configuration of the VNC Secret
  • Reboot command/action added to Client Area (ie. on/off/hard-off)
  • Link from Health tab of Admin GUI to WHMCS Marketplace re: reviews
  • Images for all supported Operating Systems & Kernel types (some fixed)
  • Ground-work for noVNC overhaul, to support PVE Auth & VNC Tunnel tickets

Polish

  • Stop VM/CT (Client Area) renamed to Hard Stop, compared to Shut Down
  • Modify the PHP API2 class, adding getTicket() so we can dual-auth (VNC)
  • Move VNC Clients from root-level to vnc-only-level access to Proxmox VE

Bug Fix

  • noVNC render method updated to stop out-of-order data flow problem
  • noVNC back-end vncproxy and vncwebsocket methods updated re: spec
  • Client Area actions (Power Off/On, etc) fixed for LXC (QEMU OK)
  • Error with both VNC methods. We are going to remove TigerVNC

 

v1.2.0 Released June 18th, 2023

View/hide detailed changelog

Feature

  • Link off to GitHub Issues for Support from the Module page in WHMCS
  • CHANGELOG.md file added to repository to track in recommended format
  • Try-catch around the Creation API Call, routing OK/error into WHMCS
  • Feed the IP/GW configuration into QEMU and LXC creation attempts
  • PVE Storage > Volume Name and Disk I/O Limit fields added (#7)
  • Module, PHP & Server reported on the Health/Support GUI tab
  • Licensed repository/module via GPLv3 (link-back attribution)
  • Warning in README.md re: WHMCS Service ID being > 100
  • Zero Tolerance Abuse Policy added to README file

Polish

  • Module versioning changed to semver (semantic versioning) 1.2.0
  • Change rel. path to ROOTDIR in IPv4 file, in case of other issues
  • Use /cluster/resources via API, not /node/, to get stats (ex. swap)
  • Updated noVNC, TigerVNC, Ubuntu, Debian and CentOS interface images
  • Improved error handling and pass-back from Proxmox to Class to WHMCS
  • Updated the PVE2 API Class and improved its logging (prefix/exception)
  • Method to fire API Calls updated due to reduction in WHMCS param scope

Bug Fix

  • Regression in v1.1 with missing semicolon breaking activation (#14)
  • Edit Icon not rendering on IP/Pool edit page, missing asset (#13)
  • Relative link to PVE2 API Class file broken, use ROOTDIR (#13/15)
  • IPv4 Address functions, update file to use float not real (#13)
  • Container (CT/LXC) Swap reporting in Client Area now working
  • RRD (Usage) measurements: params attached to requests OK
  • API Requests for Creation now functional (fixes #17)
  • Client Area pages/actions now fixed (fixes #19)
  • Font Awesome icons fixed in the Client Area

 

v1.1 Released June 6th, 2023

View/hide detailed changelog

Feature

  • Swap space editing for plans; back-end existed but not GUI editing
  • Modern-day language to GUI according to changes in the 6 years

Polish

  • Module Name from "PRVE" to "pvewhmcs" (ie. Proxmox VE for WHMCS)
  • Default storage/disk type changed from IDE to Virtio (fastest)
  • Updated 3 dependencies to latest: PVE2-PHP, NoVNC, TigerVNC
  • Removed all code segments relating to software licensing
  • DNS defaults changed from Google DNS to Cloudflare DNS

Bug Fix

  • Module can now be installed onto WHMCS 8.x installations
  • OpenVZ changed to LXC, to support PVE 4 installs and up
  • Removed I/O Priority setting, to re-do via Throttling
  • Catch error in Client Area if can't reach Proxmox

 

See also

Hetzner Servers Manager

Integrate manager for Hetzner Dedicated

Commercial
Liquid Web VPS & Cloud Dedicated Reseller Program

Resell VPS & Cloud Dedicated Products from Liquid Web

Free
Acronis Cyber Protect Cloud

AI-Powered Integration of Data Protection and Cybersecurity.

Free
SolusVM WHMCS module

Automate the sale of VPS servers & give your clients the ability to completely manage their VPS server inside of WHMCS, using the industry leading SolusVM control panel.

Free
Teamspeak / TeaSpeak provisioning addon

Teamspeak / TeaSpeak server provisioning addon

Commercial