Personal tools
Namespaces

Variants
Actions

Proxmox VE VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 5: Line 5:
 
{|
 
{|
 
|style="padding: 10px 0px 10px 0px;"|'''Proxmox VPS For WHMCS''' is a powerful module which allows you to automatically provision virtual servers to your customers.<br />
 
|style="padding: 10px 0px 10px 0px;"|'''Proxmox VPS For WHMCS''' is a powerful module which allows you to automatically provision virtual servers to your customers.<br />
−
Additionally it allows you to conveniently manage all existing servers, IP addresses and clusters through special addon attached to the module.<br />
+
Additionally it allows you to conveniently manage all existing servers, IP addresses and clusters through a special addon attached to the module.<br />
−
The great advantage of this module is the fact that customers can manage virtual servers, backups and much more in your own WHMCS client area!
+
Great advantage of this module is the fact that customers can manage virtual servers, backups and many more in your own WHMCS client area!
 
|}
 
|}
 +
<!-- comment can fix everything -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
Line 43: Line 44:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console Access
+
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ SPICE Console
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Migrate Server Between Nodes
 
|}
 
|}
 
{|
 
{|
Line 109: Line 116:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Backup Files & Job Limits (Max Number Of Files & Max Size Of Files)
 
|style="padding: 0px 0px 0px 30px;"|✔ Backup Files & Job Limits (Max Number Of Files & Max Size Of Files)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Server Snapshot
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Manage Network Devices
 
|}
 
|}
 
{|
 
{|
Line 229: Line 242:
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Proxmox VPS For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Proxmox VPS For WHMCS.''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
Line 237: Line 250:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 243: Line 256:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_2.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Proxmox VPS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Proxmox VPS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located at the '' 'modules/servers/proxmoxVPS/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
File is located at '' 'modules/servers/proxmoxVPS/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_3.png]]
 
|}
 
|}
 
{|
 
{|
Line 258: Line 271:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_4.png]]
 
|}
 
|}
  
 
==Activation of Proxmox Addon==
 
==Activation of Proxmox Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Firstly we should activate Proxmox Addon.''' <br />
+
|style="padding: 10px 0px 15px 15px;"|'''5. Firstly, activate Proxmox Addon.''' <br />
 
To do so, log in into your WHMCS and press '' 'Setup' '' → '' 'Addon Modules' ''. Find '' 'Proxmox Addon' '' and press '' 'Activate' ''.
 
To do so, log in into your WHMCS and press '' 'Setup' '' → '' 'Addon Modules' ''. Find '' 'Proxmox Addon' '' and press '' 'Activate' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. In next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.  
 
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_6.png]]
 
|}
 
|}
  
Line 280: Line 293:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''7. Now, we will show you how to configure a new product.''' <br />
 
|style="padding: 10px 0px 15px 15px;"|'''7. Now, we will show you how to configure a new product.''' <br />
−
Go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button.
+
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_7.png]]
 
|}
 
|}
 
{|
 
{|
Line 289: Line 302:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_8.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''9. After configuring your server correctly, you will see a following screen.''' <br />
 
|style="padding: 0px 0px 15px 15px;"|'''9. After configuring your server correctly, you will see a following screen.''' <br />
−
In order to check connection with Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below.  
+
In order to check connection with a Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_9.png]]
 
|}
 
|}
 
{|
 
{|
Line 302: Line 315:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_10.png]]
 
|}
 
|}
 
{|
 
{|
Line 308: Line 321:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_11.png]]
 
|}
 
|}
  
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
Click on '' 'Create a New Group' ''.   
 
Click on '' 'Create a New Group' ''.   
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_12.png]]
 
|}
 
|}
 
{|
 
{|
Line 323: Line 336:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_13.png]]
 
|}
 
|}
 
{|
 
{|
Line 330: Line 343:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_14.png]]
 
|}
 
|}
 
{|
 
{|
Line 337: Line 350:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Now go to the '' 'Module Settings' '' section, choose both '' 'Proxmox VPS' '' and your previously created server group from dropdown menus.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Now go to '' 'Module Settings' '' section, choose both '' 'Proxmox VPS' '' and your previously created server group from dropdown menus.<br />
 
Next, click on '' 'Save Changes' ''.'''
 
Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_16.png]]
 
|}
 
|}
 
{|
 
{|
Line 352: Line 365:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_17.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)'''<br />
 
From dropdown menus choose '' 'KVM OS Type' '' and '' 'Default Storage' ''.<br />
 
From dropdown menus choose '' 'KVM OS Type' '' and '' 'Default Storage' ''.<br />
−
Type your VM description in '' 'Container Description' '' and scroll down.
+
Type your VM description in '' 'Container Description' '' and scroll down.<br />
 +
You can also define VM prefix by filling in '' 'Default KVM Container Prefix' '' field.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. Now, select desired values from '' 'Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '', '' 'ISO Image' '', '' 'Network Mode' '' and'' 'Network Model' ''.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''19. Now, select desired values from '' 'Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '', '' 'ISO Image' '', '' 'Network Mode' '' and'' 'Network Model' ''.'''<br />
−
If you are using [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you can assign configuration with IPv4 and IPv6 pools at '' 'IP Manager' '' section.<br />
+
−
For more information, visit [http://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#IP_Manager_Integration IP Manager Integration] section.<br />
+
 
Additionally, set up backups at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
 
Additionally, set up backups at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
−
Backups routing automatically remove oldest backup as soon as new backup is created and backup limit is reached.
+
Backups routing automatically removes the oldest backup as soon as a new backup is created and a backup limit is reached.<br />
 +
Type in the number of days into '' 'Delete Backup's Older Than N Days' '' to remove backups older than the provided number of days.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX18_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_19.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''20. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''20. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)'''<br />
 
From dropdown menus choose '' 'Default Storage' '' and '' 'OpenVZ OS Template' ''.<br />
 
From dropdown menus choose '' 'Default Storage' '' and '' 'OpenVZ OS Template' ''.<br />
−
If you are using [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you can assign configuration with IPv4 and IPv6 pools at '' 'IP Manager' '' section.<br />
 
−
For more information, visit [http://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#IP_Manager_Integration IP Manager Integration] section.<br />
 
 
Additionally, define backup settings at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
 
Additionally, define backup settings at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
 
Backups routing automatically delete oldest backup when new backup is created and backup limit is reached.<br />
 
Backups routing automatically delete oldest backup when new backup is created and backup limit is reached.<br />
−
Type your VM description in '' 'Container Description' '' and press '' 'Save Changes' ''.
+
Fill in number of days into '' 'Delete Backup's Older Than N Days' '' to remove backups older than provided amount of days.<br />
 +
Type your VM description into '' 'Container Description' '' and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_20.png]]
 
|}
 
|}
 
{|
 
{|
Line 388: Line 400:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX19_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen below.
+
|style="padding: 0px 0px 30px 15px;"|By doing so, you have just added required custom fields and optional configurable options listed in the table below.
 
|}
 
|}
 
{| class="wikitable"
 
{| class="wikitable"
Line 438: Line 450:
  
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''22. At the end of product configuration you have to add cron job shown below (each 5 minutes suggested).<br />
+
|style="padding: 0px 0px 15px 15px;"|'''22. At the end of a product configuration you have to add a cron job shown below (each 5 minutes suggested).<br />
−
  php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.php<br />
+
  php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.php
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
|}
 
|}
Line 454: Line 466:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''24. Start of typing desired IP address and mask into '' 'IP Pool' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''24. Start by typing desired IP address and mask into '' 'IP Pool' ''.'''<br />
−
Next, choose server from a '' 'Server' '' dropdown menu and define for which virtualization should it be applied through selecting from '' 'Visualization' '' dropdown menu.<br />
+
Next, choose a server from a '' 'Server' '' dropdown menu and define which virtualization it should it be applied for through selecting it from '' 'Visualization' '' dropdown menu.<br />
 
Afterwards, press '' 'Add Pool' ''.
 
Afterwards, press '' 'Add Pool' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''25. You are now able to create new product using previously added IP address.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''25. You are now able to create a new product using the previously added IP address.'''<br />
−
If you used KVM virtualization type, the client area of successfully created product should look similar to the one on the screen below.
+
If you use KVM virtualization type, client area in a successfully created product should look similar to the one on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_24.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''26.The client area of product using OpenVZ virtualization type looks quite similar.'''
+
|style="padding: 0px 0px 20px 15px;"|'''26.Client area in the product using OpenVZ virtualization type looks quite similar.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_25.png]]
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
−
You can monitor and manage each product from your WHMCS admin area.<br />
+
You can monitor and manage each product from your WHMCS admin area.
−
You are also able to add IP address to product. To do so, press '' 'Add New IP' '' as shown on the following screen.
+
 
|}
 
|}
 +
==Admin Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX23_5.png]]
+
|style="padding: 10px 0px 15px 15px;"|From the admin area you are able to view details and manage your client's VMs, access VMs consoles and even migrate VMs between nodes.<br />
 +
You are also able to add an IP address to a product. To do so, press '' 'Add New IP' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, enter IP address in a textbox and confirm through '' 'Save Changes' ''.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX23_6.png]]
+
|style="padding: 0px 0px 20px 15px;"|Afterwards, enter IP address in a textbox and confirm through pressing '' 'Save Changes' ''.
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PX_27.png]]
 +
|}
 +
 
==Management of Addon==
 
==Management of Addon==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Server List' '' you can find servers you have configured.<br />
 
|style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Server List' '' you can find servers you have configured.<br />
−
To see what product was created and assigned to your Proxmox server simply click on its '' 'Server Name' ''.
+
To see the list of products created and assigned to your Proxmox server simply click on its '' 'Server Name' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_28.png]]
 
|}
 
|}
 
{|
 
{|
Line 505: Line 522:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_29.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|At the '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products.  
+
|style="padding: 0px 0px 20px 15px;"|At '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains clusters list. To view information about cluster simply press on its name.  
+
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains the list of clusters. To view information about a cluster simply press its name.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX26_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can find various information about cluster, from available resource to graph of their use.
+
|style="padding: 0px 0px 20px 15px;"|Here you can find various information about a cluster, from available resource to usage graphs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX26_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_32.png]]
 
|}
 
|}
 
===Templates Management===
 
===Templates Management===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM at your server to template.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM on your server to a template.<br />
−
In order to convert VM, go to the '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template' ''.<br />
+
In order to convert VM, go to '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template' ''.<br />
−
Choose server on which VM to convert exist and press '' 'Next Step' ''.<br />
+
Choose server on which VM to convert exists and press '' 'Next Step' ''.<br />
−
'''Important: VM will be consumed in process.'''
+
'''Important: VM will be destroyed in the process.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX26_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_33.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Next, choose node and VM to convert.<br />
 
|style="padding: 0px 0px 15px 15px;"|Next, choose node and VM to convert.<br />
−
Fill '' 'Template Friendly Name' '' and press '' 'Save Changes' ''.
+
Fill in '' 'Template Friendly Name' '' and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX26_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_34.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To access list of all available templates go to the '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Show Templates' ''.
+
|style="padding: 0px 0px 20px 15px;"|To access the list of all available templates go to '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Show Templates' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX26_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_35.png]]
 
|}
 
|}
  
−
==Interface==
+
==Client Area==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.<br />
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.<br />
−
As you can see, control panel contains useful options needed for managing VPS.<br />
+
As you can see, control panel contains options useful for managing VM.<br />
−
Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.<br />
+
The module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing a specific button.<br />
−
Clients can also reinstall(5) server, access VNC console(6), create backup(7) and set up backup jobs(8).<br />
+
Clients can also reinstall(5) server, access VNC(6) and SPICE(7) consoles, create backup(8) and set up backup jobs(9).<br />
−
Additionally, your clients are able to access graph of resource usage(9) and view VM history(10).
+
Additionally, your clients are able to access resource usage graphs(10), view VM history(11) and manage network interface device(12).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_36.png]]
 
|}
 
|}
−
===VNC Console===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is VNC console(6) where your clients can remotely manage their servers.<br />
+
|style="padding: 0px 0px 15px 15px;"|At the main product page in the client area, under '' 'Details' '' headline your clients can find information about current usage of CPU, memory and disk (OpenVZ only).<br />
−
To access it, simply press on the '' 'Console' '' button. Console requires Java software. You need to accept security risk to run it.
+
Customers can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX28.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_37.png]]
 
|}
 
|}
 
===Reinstall===
 
===Reinstall===
Line 573: Line 589:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX29.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_38.png]]
 
|}
 
|}
−
===Backup Jobs & Backup===
+
===VNC Console===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' ''(8) in your client area, you will be carried to backup jobs management page.<br />
+
|style="padding: 10px 0px 15px 15px;"|VNC console (6) enables your clients to remotely manage their servers.<br />
−
To add a new backup job press '' 'New Job' '' as shown on the following screen.
+
To access it, simply press the '' 'VNC Console' '' button. Console requires Java software. You need to accept security risk to run it.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_39.png]]
 
|}
 
|}
 +
 +
===Spice Console===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now define backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
+
|style="padding: 10px 0px 15px 15px;"|Spice console (7) enables you to connect with virtual machine using SPICE.<br />
−
Next, press '' 'Add' '' button.
+
''Note: Your client needs to [http://www.spice-space.org/download.html download] and install client side SPICE application in order to connect with VM.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_40.png]]
 
|}
 
|}
 +
 +
===Backup===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also create a single backup. To do so, press '' 'Backup' '' (7) button and click on '' 'New Backup' '' as shown on the following screen.
+
|style="padding: 10px 0px 20px 15px;"|To create a single backup, press '' 'Backup' ''(8) button and click on '' 'New Backup' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX31_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_41.png]]
 
|}
 
|}
 
{|
 
{|
Line 601: Line 621:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX31_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_42.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To restore VM from backup simply press '' 'Restore' '' and then click '' 'OK' '' button in a popup window to confirm.
+
|style="padding: 0px 0px 20px 15px;"|To restore VM from backup, press '' 'Restore' '' and then click '' 'OK' '' button in a popup window to confirm.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX31_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_43.png]]
 
|}
 
|}
 +
===Backup Jobs===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|At the main product page in the client area, under '' 'Details' '' headline your clients can find information about current usage of CPU, memory and disk (OpenVZ only).<br />
+
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' ''(9) in your client area, you will be carried to a backup jobs management page.<br />
−
Customers can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses' ''.
+
To add a new backup job press '' 'New Job' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_44.png]]
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, define backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
 +
Next, press '' 'Add' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PX_45.png]]
 +
|}
 +
 
===Graphs===
 
===Graphs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Through pressing '' 'Graphs' ''(9) button clients will be moved to page with graph of CPU usage, memory usage, network traffic and disc I/O.<br />
+
|style="padding: 10px 0px 15px 15px;"|Through pressing '' 'Graphs' ''(10) button clients will be moved to the page with graph of CPU usage, memory usage, network traffic and disc I/O.<br />
−
They can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
+
They can also switch the timeline of graphs by choosing it from a dropdown menu pointed at the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX33.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_46.png]]
 
|}
 
|}
 
===Task History===
 
===Task History===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Your clients are able to easily access history of theirs VMs by simply pressing '' 'Task History' ''(10) button.
+
|style="padding: 10px 0px 20px 15px;"|To access history of VM, simply press '' 'Task History' ''(10) button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_0.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_47.png]]
 +
|}
 +
===Network===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Your clients are able to easily create and remove network interface device.<br />
 +
''Note: You are allowed to remove only private network interface devices.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PX_48.png]]
 
|}
 
|}
  
Line 635: Line 672:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Owing to integration with [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you are able to easily create pools of IP addresses and assign them to desired products.<br />
 
|style="padding: 10px 0px 15px 15px;"|Owing to integration with [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you are able to easily create pools of IP addresses and assign them to desired products.<br />
−
1. Proceed to the IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#IP_Pools IP Pools] in order to prepare IP addresses pool for Proxmox VPS For WHMCS.<br />
+
1. Proceed to IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#IP_Pools IP Pools] tab in order to prepare IP addresses pool for Proxmox VPS For WHMCS.<br />
−
2. Edit a previously created IP addresses pool and create custom field '' 'MAC Address' '' with desired MAC address to each IP address in the pool.<br />
+
2. Edit a previously created IP addresses pool and create custom field '' 'MAC Address' '' with desired MAC address at each IP address in the pool.<br />
−
More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Custom_Fields_For_IP_Addresses here].<br />
+
More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Custom_Fields_For_IP_Addresses here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX33_1_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_49.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign previously created pool to it.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign a previously created pool to it.<br />
−
''Note 1: Do not assign Proxmox VPS For WHMCS product to configuration. Simply, create new configuration with assigned IP addresses pool.''<br />
+
''Note: Multiple IP addresses pools can be assigned to a single configuration.''<br />
−
''Note 2: Multiple IP addresses pools can be assigned to one configuration.''<br />
+
4. Now, link the configuration with Proxmox VPS product via a product, a server or a configurable option.<br />
−
4. In order to finish, go to the Proxmox VPS For WHMCS product → '' 'Module Settings' ''.<br />
+
On the following screen we have linked them via configurable option assigned to Proxmox VPS product.
−
Find '' 'IP Manager' '' section and choose previously created configuration from '' 'Configuration IPv4' '' or '' 'Configuration IPv6' '' dropdown menu.<br />
+
−
Finish through pressing '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_1_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_50.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. Now, enable integration by proceeding to '' '3rd Party Integration' '' tab.<br />
 +
Press '' 'Activate' '' next to '' 'proxmoxVPS' '' module type as shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PX_51.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. Next, assign a previously created configuration to the submodule.<br />
 +
Press '' 'Configure' '', choose the configuration and press '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PX_52.png]]
 
|}
 
|}
−
 
 
==Configurable Options==
 
==Configurable Options==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your client can order it by choosing from default configurable options.
+
|style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your client can order it by choosing from the default configurable options.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX33_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_53.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In case those options aren't fitting your needs, you can edit them.<br />
+
|style="padding: 0px 0px 15px 15px;"|In case those options do not fit your needs, you can edit them.<br />
−
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' '' and press edit button next to configurable option used by your product.<br />
+
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' '' and press edit button next to the configurable option used by your product.
−
Its name is '' 'Configurable options for your_product_name' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX33_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_54.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can view all products this configurable option group is assigned to.<br />
+
|style="padding: 0px 0px 15px 15px;"|Here you can view all the products this configurable option group is assigned to.<br />
 
Now, we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.<br />
 
Now, we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.<br />
 
To do so, edit '' 'The number of cores per socket' '' by pressing edit button as shown on the screen below.
 
To do so, edit '' 'The number of cores per socket' '' by pressing edit button as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX33_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_55.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|You will see a popup window, so make sure your browser will not block it.<br />
 
|style="padding: 0px 0px 15px 15px;"|You will see a popup window, so make sure your browser will not block it.<br />
−
To add new option enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.<br />
+
To add a new option, enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.<br />
−
Next, press '' 'Save Changes' ''.
+
Finish through pressing '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_56.png]]
 
|}
 
|}
 +
 
==Management of Billing==
 
==Management of Billing==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|When you combine Proxmox VPS For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
 
|style="padding: 10px 0px 15px 15px;"|When you combine Proxmox VPS For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
−
Module allows you to charge your customers based on the server resources used by them.
+
Module allows you to charge your customers basing on the server resources used by them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX34.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_57.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing For WHMCS module, you can also display your customers the current server resource usage and their cost.
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing For WHMCS module, you can also display your customers current server resource usage and their cost.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PX_58.png]]
 
|}
 
|}
 +
 
==Management of Existing Accounts==
 
==Management of Existing Accounts==
 
{|
 
{|
Line 704: Line 753:
 
1. Create and configure a Proxmox VPS server and a server group.<br />
 
1. Create and configure a Proxmox VPS server and a server group.<br />
 
2. Create and configure a Proxmox VPS product.<br />
 
2. Create and configure a Proxmox VPS product.<br />
−
3. Place new order with previously created product for your customer. '''Do not activate product yet.'''<br />
+
3. Place a new order with a previously created product for your customer. '''Do not activate product yet.'''<br />
−
4. Go to '' 'Products/Services' '' section of freshly created product and fill 4 custom fields.<br />
+
4. Access the just created product from the admin area via client profile → '' 'Products/Services' '' section and fill in 4 custom fields.<br />
 
They are '' 'vmid' '', '' 'node' '', '' 'storage' '' and '' 'backup storage' ''.<br />
 
They are '' 'vmid' '', '' 'node' '', '' 'storage' '' and '' 'backup storage' ''.<br />
 
5. If possible, enter IP addresses into fields '' 'Dedicated IP' '' and '' 'Assigned IPs' ''.<br />
 
5. If possible, enter IP addresses into fields '' 'Dedicated IP' '' and '' 'Assigned IPs' ''.<br />
 
6. Set product status to '' 'Active' ''.<br /><br />
 
6. Set product status to '' 'Active' ''.<br /><br />
−
'''Remember to not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''
+
'''Remember, do not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''
 
|}
 
|}
  

Revision as of 14:42, 15 October 2014

Contents

About Proxmox VPS For WHMCS

Proxmox VPS For WHMCS is a powerful module which allows you to automatically provision virtual servers to your customers.

Additionally it allows you to conveniently manage all existing servers, IP addresses and clusters through a special addon attached to the module.
Great advantage of this module is the fact that customers can manage virtual servers, backups and many more in your own WHMCS client area!

  • Admin Area Features:
✔ Create Server
✔ Suspend/Unsuspend Server
✔ Terminate Server
✔ Change Package (Supports Configurable Options)
✔ Boot Server
✔ Reboot Server
✔ Stop Server
✔ Reinstall Server
✔ View Server Status, Details And Statistics
✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
✔ Display Disk And Bandwidth Usage Of Each Product
✔ VNC Console
✔ SPICE Console
✔ Migrate Server Between Nodes
✔ Auto Node - Possibility To Automatically Create VM On The Node With The Most Free Space
✔ Possibility To Import IP Address To Hosting IP Addresses Table
✔ Possibility To Return IP Address To IP Addresses Pool
✔ Possibility To Add Additional IP Address To VM
✔ Configuration Of Features Available At The Client Area
  • Proxmox Addon Features:
✔ Servers List
✔ IP Management (Per Server)
✔ Clusters (Per Server)
✔ KVM Templates
  • Client Area Features:
✔ Boot Server
✔ Reboot Server
✔ Stop Server
✔ Shutdown Server
✔ Reinstall Server
✔ VNC Console
✔ Create Backups
✔ Restore Backups
✔ Backup Jobs
✔ Backups Routing
✔ Task History
✔ Backup Files & Job Limits (Max Number Of Files & Max Size Of Files)
✔ Create Server Snapshot
✔ Manage Network Devices
✔ View Server Status, Details And Statistics
✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
✔ Display Disk And Bandwidth Usage
✔ Easy Product Upgrade/Downgrade
  • General Info:
✔ Supports PVE And PAM Authentication
✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Pools (read more)
✔ Multi-Language Support
✔ Supports Proxmox VE 3 and Later
✔ Supports IPv4 and IPv6
✔ Supports WHMCS V5 and Later
  • Available Configurable Options:
✔ KVM:
✔ Number of CPU Sockets
✔ Number of Cores Per Socket
✔ CPU Weight For a VM
✔ Amount of RAM
✔ Disk Space
✔ Network Rate
✔ IPv4 Addresses
✔ IPv6 Addresses
✔ Backups Limit
✔ Backups Files Limit
✔ Bandwidth Limit
✔ VM Template
✔ ISO Image
✔ OpenVZ:
✔ The Number of CPU Sockets
✔ Amount of SWAP
✔ CPU Weight For a VM
✔ Amount of RAM
✔ Disk Space
✔ IPv4 Addresses
✔ IPv6 Addresses
✔ Backups Limit
✔ Backups Files Limit
✔ Bandwidth Limit
✔ VM Templates

Installation and Configuration

This tutorial will show you how to successfully install and configure Proxmox VPS For WHMCS.

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

Installation

1. Log in to your client area and download Proxmox VPS For WHMCS.
File:PX 1.png
2. Upload and extract the module into the main WHMCS directory.
File:PX 2.png
3. When you install Proxmox VPS for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/servers/proxmoxVPS/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

File:PX 3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen.
You can find your license key at your client area → 'My Products' .

File:PX 4.png

Activation of Proxmox Addon

5. Firstly, activate Proxmox Addon.

To do so, log in into your WHMCS and press 'Setup' → 'Addon Modules' . Find 'Proxmox Addon' and press 'Activate' .

File:PX 5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .

File:PX 6.png

Configuration of Server

7. Now, we will show you how to configure a new product.

Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' button.

File:PX 7.png
8. Next, enter your server name, IP address, username and password. Choose authentication type from 'Authentication' and 'Proxmox VPS' from 'Type' dropdown menus. Confirm through pressing 'Save Changes' .
File:PX 8.png
9. After configuring your server correctly, you will see a following screen.

In order to check connection with a Proxmox server, simply press 'Test Connection' as shown on the screen below.

File:PX 9.png
10. It is time to create a server group, to do so click on 'Create Server Group' .
File:PX 10.png
11. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes' .
File:PX 11.png

Configuration of Product

12. In order to create and configure a product go to 'Setup' → 'Products/Services' → 'Products/Services' .

Click on 'Create a New Group' .

File:PX 12.png
13. Enter product group name and press 'Save Changes' .
File:PX 13.png
14. When you have a product group, you can assign your product to it.

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

File:PX 14.png
15. Afterwards, choose your product group and type from dropdown menus, enter your product name and press 'Continue' .

'Product Type' should be set to 'Dedicated/VPS Server' in order to add nameservers later.

File:PX 15.png
16. Now go to 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus.

Next, click on 'Save Changes' .

File:PX 16.png
17. From dropdown menus choose 'Virtualization Type' , 'Default Node' and 'Template & ISO Storage' .

Afterwards, press 'Save Changes' .
Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.

File:PX 17.png
18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)

From dropdown menus choose 'KVM OS Type' and 'Default Storage' .
Type your VM description in 'Container Description' and scroll down.
You can also define VM prefix by filling in 'Default KVM Container Prefix' field.

File:PX 18.png
19. Now, select desired values from 'Storage' , 'Disk Type' , 'CD/DVD-ROM Type' , 'ISO Image' , 'Network Mode' and 'Network Model' .

Additionally, set up backups at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically removes the oldest backup as soon as a new backup is created and a backup limit is reached.
Type in the number of days into 'Delete Backup's Older Than N Days' to remove backups older than the provided number of days.

File:PX 19.png
20. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)

From dropdown menus choose 'Default Storage' and 'OpenVZ OS Template' .
Additionally, define backup settings at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically delete oldest backup when new backup is created and backup limit is reached.
Fill in number of days into 'Delete Backup's Older Than N Days' to remove backups older than provided amount of days.
Type your VM description into 'Container Description' and press 'Save Changes' .

File:PX 20.png
21.Afterwards, press 'Generate default' nearby 'Configurable Options' and 'Custom Fields' .
File:PX 21.png
By doing so, you have just added required custom fields and optional configurable options listed in the table below.
KVM Open VZ
The number of CPU sockets The number of CPU sockets
The number of cores per socket Amount of SWAP
CPU weight for a VM CPU weight for a VM
Amount of RAM Amount of RAM
Disk Space Disk Space
Network Rate IPv4 Addresses
IPv4 Addresses IPv6 Addresses
IPv6 Addresses Backups Limit
Backups Limit Backups Files Limit
Backups Files Limit Bandwidth Limit
Bandwidth Limit VM Template
VM Template
ISO Image
22. At the end of a product configuration you have to add a cron job shown below (each 5 minutes suggested).
 
php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.php

Do not forget to replace 'your_whmcs' with your WHMCS root location.

Congratulations! You have just finished the installation and configuration of the module.

Configuration of Addon

23. Adding new IP address (if you are not using IP Manager For WHMCS).

In order to create new product you have to add product 'Dedicated IP ' to 'IP Addresses' list in 'Proxmox' addon module.
To do so, go to 'Addons' → 'Proxmox Addon' → 'IP Management' and press 'Add Pool' .
Note: You can add both IPv4 and IPv6 addresses.

File:PX 22.png
24. Start by typing desired IP address and mask into 'IP Pool' .

Next, choose a server from a 'Server' dropdown menu and define which virtualization it should it be applied for through selecting it from 'Visualization' dropdown menu.
Afterwards, press 'Add Pool' .

File:PX 23.png
25. You are now able to create a new product using the previously added IP address.

If you use KVM virtualization type, client area in a successfully created product should look similar to the one on the screen below.

File:PX 24.png
26.Client area in the product using OpenVZ virtualization type looks quite similar.
File:PX 25.png

Management

Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.

Admin Area

From the admin area you are able to view details and manage your client's VMs, access VMs consoles and even migrate VMs between nodes.

You are also able to add an IP address to a product. To do so, press 'Add New IP' as shown on the following screen.

File:PX 26.png
Afterwards, enter IP address in a textbox and confirm through pressing 'Save Changes' .
File:PX 27.png

Management of Addon

In 'Addons' → 'Proxmox Addon' → 'Server List' you can find servers you have configured.

To see the list of products created and assigned to your Proxmox server simply click on its 'Server Name' .

File:PX 28.png
As you can see on the screen below, you can find a lot of useful information here like e.g. IP Address, VM ID or VM Type.
File:PX 29.png
At 'IP Management' tab you can add, edit and remove IP addresses of Proxmox products.
File:PX 30.png
'Clusters' tab contains the list of clusters. To view information about a cluster simply press its name.
File:PX 31.png
Here you can find various information about a cluster, from available resource to usage graphs.
File:PX 32.png

Templates Management

You can easily convert any VM on your server to a template.

In order to convert VM, go to 'Proxmox Addon' → 'Templates' → 'Create Template' .
Choose server on which VM to convert exists and press 'Next Step' .
Important: VM will be destroyed in the process.

File:PX 33.png
Next, choose node and VM to convert.

Fill in 'Template Friendly Name' and press 'Save Changes' .

File:PX 34.png
To access the list of all available templates go to 'Proxmox Addon' → 'Templates' → 'Show Templates' .
File:PX 35.png

Client Area

Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.

As you can see, control panel contains options useful for managing VM.
The module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing a specific button.
Clients can also reinstall(5) server, access VNC(6) and SPICE(7) consoles, create backup(8) and set up backup jobs(9).
Additionally, your clients are able to access resource usage graphs(10), view VM history(11) and manage network interface device(12).

File:PX 36.png
At the main product page in the client area, under 'Details' headline your clients can find information about current usage of CPU, memory and disk (OpenVZ only).

Customers can also view 'DNS' (OpenVZ only) and 'IP Addresses' .

File:PX 37.png

Reinstall

Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on 'Reinstall' (5) button.
File:PX 38.png

VNC Console

VNC console (6) enables your clients to remotely manage their servers.

To access it, simply press the 'VNC Console' button. Console requires Java software. You need to accept security risk to run it.

File:PX 39.png

Spice Console

Spice console (7) enables you to connect with virtual machine using SPICE.

Note: Your client needs to download and install client side SPICE application in order to connect with VM.

File:PX 40.png

Backup

To create a single backup, press 'Backup' (8) button and click on 'New Backup' as shown on the following screen.
File:PX 41.png
Now, choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.

Afterwards, press 'Add Backup' .

File:PX 42.png
To restore VM from backup, press 'Restore' and then click 'OK' button in a popup window to confirm.
File:PX 43.png

Backup Jobs

By pressing 'Backup Jobs' (9) in your client area, you will be carried to a backup jobs management page.

To add a new backup job press 'New Job' as shown on the following screen.

File:PX 44.png
Now, define backup time, mark days to run it and choose 'Compression Dump File' and 'Backup Mode' from dropdown menus.

Next, press 'Add' button.

File:PX 45.png

Graphs

Through pressing 'Graphs' (10) button clients will be moved to the page with graph of CPU usage, memory usage, network traffic and disc I/O.

They can also switch the timeline of graphs by choosing it from a dropdown menu pointed at the following screen.

File:PX 46.png

Task History

To access history of VM, simply press 'Task History' (10) button.
File:PX 47.png

Network

Your clients are able to easily create and remove network interface device.

Note: You are allowed to remove only private network interface devices.

File:PX 48.png

IP Manager Integration

Owing to integration with IP Manager For WHMCS you are able to easily create pools of IP addresses and assign them to desired products.

1. Proceed to IP Manager For WHMCS → IP Pools tab in order to prepare IP addresses pool for Proxmox VPS For WHMCS.
2. Edit a previously created IP addresses pool and create custom field 'MAC Address' with desired MAC address at each IP address in the pool.
More about creating custom fields can be found here.

PX 49.png
3. Afterwards, create a new configuration and assign a previously created pool to it.

Note: Multiple IP addresses pools can be assigned to a single configuration.
4. Now, link the configuration with Proxmox VPS product via a product, a server or a configurable option.
On the following screen we have linked them via configurable option assigned to Proxmox VPS product.

PX 50.png
5. Now, enable integration by proceeding to '3rd Party Integration' tab.

Press 'Activate' next to 'proxmoxVPS' module type as shown on the following screen.

PX 51.png
5. Next, assign a previously created configuration to the submodule.

Press 'Configure' , choose the configuration and press 'Save Changes' .

PX 52.png

Configurable Options

When you successfully set up a product, your client can order it by choosing from the default configurable options.
File:PX 53.png
In case those options do not fit your needs, you can edit them.

Go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to the configurable option used by your product.

File:PX 54.png
Here you can view all the products this configurable option group is assigned to.

Now, we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.
To do so, edit 'The number of cores per socket' by pressing edit button as shown on the screen below.

File:PX 55.png
You will see a popup window, so make sure your browser will not block it.

To add a new option, enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.
Finish through pressing 'Save Changes' .

File:PX 56.png

Management of Billing

When you combine Proxmox VPS For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers basing on the server resources used by them.

PX 57.png
With Advanced Billing For WHMCS module, you can also display your customers current server resource usage and their cost.
PX 58.png

Management of Existing Accounts

You can easily use Proxmox VPS module with your existing Proxmox accounts. To do so, follow the instructions below:

1. Create and configure a Proxmox VPS server and a server group.
2. Create and configure a Proxmox VPS product.
3. Place a new order with a previously created product for your customer. Do not activate product yet.
4. Access the just created product from the admin area via client profile → 'Products/Services' section and fill in 4 custom fields.
They are 'vmid' , 'node' , 'storage' and 'backup storage' .
5. If possible, enter IP addresses into fields 'Dedicated IP' and 'Assigned IPs' .
6. Set product status to 'Active' .

Remember, do not click 'Create' button during the entire process. That would unnecessarily create a new virtual machine.

Tips

1. Operations performed on the virtual servers are not executed immediately. Give your Proxmox Virtual Environment some time for processing the request and execution of operation.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Proxmox_VE_VPS_For_WHMCS&oldid=14747"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Proxmox VE VPS For WHMCS