Personal tools
Namespaces

Variants
Actions

Proxmox VE VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Proxmox VPS For WHMCS)
Line 3: Line 3:
  
 
=About [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS For WHMCS]=
 
=About [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS For WHMCS]=
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br />
 
−
We are sorry for the inconveniences.</h4>
 
 
{|
 
{|
 
|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 />
Line 110: Line 108:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Backup 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;"|✔ Backup Limit Jobs (Max Number Of Tasks Performing Backups)
+
 
|}
 
|}
 
{|
 
{|
Line 138: Line 133:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - [http://www.modulesgarden.com/products/whmcs/ip_manager/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Complete Management of IP Pools [http://www.modulesgarden.com/products/whmcs/ip_manager/features (read more)]
 
|}
 
|}
 
{|
 
{|
Line 252: Line 247:
 
{|
 
{|
 
|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 '' 'modules/servers/proxmoxVPS/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
File is located at the '' 'modules/servers/proxmoxVPS/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
Line 285: Line 280:
 
{|
 
{|
 
|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 '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
+
Go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button.
 
|}
 
|}
 
{|
 
{|
Line 291: Line 286:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''8. Next, enter your server name, IP address, username and password. Choose '' 'Proxmox VPS' '' from a dropdown menu and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''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' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 297: Line 292:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure 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 />
−
You can check connection with Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below.  
+
In order to check connection with Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below.  
 
|}
 
|}
 
{|
 
{|
Line 318: Line 313:
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
Click on '' 'Create a New Group' ''.   
 
Click on '' 'Create a New Group' ''.   
 
|}
 
|}
Line 328: Line 323:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX13.png]]ress '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product. '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can assign your product to it.'''<br />
 
To create a product click on '' 'Create a New Product' ''.  
 
To create a product click on '' 'Create a New Product' ''.  
 
|}
 
|}
Line 345: Line 340:
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|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 />
 
Next, click on '' 'Save Changes' ''.'''
 
Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
Line 353: Line 348:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''17. From dropdown menus choose '' 'Virtualization Type' '', '' 'Default Node' '' and '' 'Template & ISO Storage' ''.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''17. From dropdown menus choose '' 'Virtualization Type' '', '' 'Default Node' '' and '' 'Template & ISO Storage' ''.'''<br />
−
Afterwards, press '' 'Save Changes' ''.
+
Afterwards, press '' 'Save Changes' ''.<br />
 
''Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.''
 
''Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.''
 
|}
 
|}
Line 361: Line 356:
 
{|
 
{|
 
|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' '', '' 'Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '', '' 'ISO Image' '', '' 'Network Mode' '', '' 'Network Model' '', '' 'Bridge' '', '' 'Node' '' and '' 'Storage' ''.<br />
+
From dropdown menus choose '' 'KVM OS Type' '' and '' 'Default Storage' ''.<br />
−
Type your VM description in '' 'Container Description' '' and click '' 'Save Changes' ''.
+
Type your VM description in '' 'Container Description' '' and scroll down.
 
|}
 
|}
 
{|
 
{|
Line 368: Line 363:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)'''<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 />
−
From dropdown menus choose '' 'OpenVZ OS Template' '', '' 'Target Storage' '', '' 'Node' '' and '' 'Storage' ''.<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#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 />
 +
Backups routing automatically remove oldest backup as soon as new backup is created and backup limit is reached.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PX18_1.png]]
 +
|}
 +
{|
 +
|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 />
 +
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#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 />
 +
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' ''.
 
Type your VM description in '' 'Container Description' '' and press '' 'Save Changes' ''.
 
|}
 
|}
Line 376: Line 385:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''20. At the end of product configuration press '' 'Generate default' '' nearby '' 'Configurable Options' '' and '' 'Custom Fields' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''21.Afterwards, press '' 'Generate default' '' nearby '' 'Configurable Options' '' and '' 'Custom Fields' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 382: Line 391:
 
|}
 
|}
 
{|
 
{|
−
|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.<br />
+
|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.
−
Left column is for configurable options for KVM virtualization type, right column is for OpenVZ.
+
 
|}
 
|}
 +
{| class="wikitable"
 +
! style="width:400px; text-align:center;" | KVM
 +
! style="width:400px; text-align:center;" | Open VZ
 +
|-
 +
| The number of CPU sockets|The number of CPU sockets
 +
| The number of CPU sockets|The number of CPU sockets
 +
|-
 +
| The number of cores per socket|The number of cores per socket
 +
| Amount of SWAP|Amount of SWAP
 +
|-
 +
| CPU weight for a VM|CPU weight for a VM
 +
| CPU weight for a VM|CPU weight for a VM
 +
|-
 +
| Amount of RAM|Amount of RAM
 +
| Amount of RAM|Amount of RAM
 +
|-
 +
| Disk Space|Disk Space
 +
| Disk Space|Disk Space
 +
|-
 +
| Network Rate|Network Rate
 +
| IP Addresses|IPv4 Addresses
 +
|-
 +
| IP Addresses|IPv4 Addresses
 +
| IPv6 Addresses|IPv6 Addresses
 +
|-
 +
| IPv6 Addresses|IPv6 Addresses
 +
| Backups Limit|Backups Limit
 +
|-
 +
| Backups Limit|Backups Limit
 +
| Backups Files Limit|Backups Files Limit
 +
|-
 +
| Backups Files Limit|Backups Files Limit
 +
| Bandwidth Limit|Bandwidth Limit
 +
|-
 +
| Bandwidth Limit|Bandwidth Limit
 +
| VM Template|VM Template
 +
|-
 +
| VM Template|VM Template
 +
|
 +
|-
 +
| ISO Image|ISO Image
 +
|
 +
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX19_2.png]]
+
|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 />
−
|}
+
php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.php<br />
 +
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 +
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! You have just finished the installation and configuration of the module.'''
 
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! You have just finished the installation and configuration of the module.'''
Line 394: Line 448:
 
==Configuration of Addon==
 
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''20. Adding new IP address.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''23. Adding new IP address (if you are not using [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS]).'''<br />
 
In order to create new product you have to add product '' 'Dedicated IP'' ' to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
 
In order to create new product you have to add product '' 'Dedicated IP'' ' to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
 
To do so, go to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'IP Management' '' and press '' 'Add Pool' ''.<br />
 
To do so, go to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'IP Management' '' and press '' 'Add Pool' ''.<br />
Line 403: Line 457:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. Type desired IP and mask in '' 'IP Pool' '' and choose server from a '' 'Server' '' dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''24. Start of 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 />
 
Afterwards, press '' 'Add Pool' ''.
 
Afterwards, press '' 'Add Pool' ''.
 
|}
 
|}
Line 410: Line 465:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''22. 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 new product using 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.<br />
+
If you used KVM virtualization type, the client area of successfully created product should look similar to the one on the screen below.
−
''Note: Screen below presents the module, right after creation of the product. Graphs will fill with data after use of certain server resources.''
+
 
|}
 
|}
 
{|
 
{|
Line 418: Line 472:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''23.The client area of product using OpenVZ virtualization type looks quite similar.'''
+
|style="padding: 0px 0px 20px 15px;"|'''26.The client area of product using OpenVZ virtualization type looks quite similar.'''
 
|}
 
|}
 
{|
 
{|
Line 426: Line 480:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 0px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 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.<br />
 
You are also able to add IP address to product. To do so, press '' 'Add New IP' '' as shown on the following screen.
 
You are also able to add IP address to product. To do so, press '' 'Add New IP' '' as shown on the following screen.
Line 434: Line 488:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 0px;"|Afterwards, enter IP address in a textbox and confirm through '' 'Save Changes' ''.
+
|style="padding: 0px 0px 20px 15px;"|Afterwards, enter IP address in a textbox and confirm through '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
Line 442: Line 496:
 
{|
 
{|
 
|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 were created and assigned to your Proxmox server simply click on it's '' 'Server Name' ''.
+
To see what product was created and assigned to your Proxmox server simply click on its '' 'Server Name' ''.
 
|}
 
|}
 
{|
 
{|
Line 448: Line 502:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, you can find a lot of useful information here like e.g. IP, VM ID or VM Type.
+
|style="padding: 0px 0px 20px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
Line 454: Line 508:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products.  
+
|style="padding: 0px 0px 20px 15px;"|At the '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products.  
 
|}
 
|}
 
{|
 
{|
Line 467: Line 521:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Here you can find various information about cluster, from available resource to graph of their use.<br />
 
|style="padding: 0px 0px 15px 15px;"|Here you can find various information about cluster, from available resource to graph of their use.<br />
−
In order to go back to cluster list, press on '' 'Back to clusters list' '' button.
+
In order to go back to the cluster list, press on '' 'Back to clusters list' '' button.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX26_3.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX26_3.png]]
 
|}
 
|}
−
 
+
===Templates Management===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM at your server to template.<br />
 +
In order to convert VM, go to the '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template' ''.<br />
 +
Choose server on which VM to convert exist and press '' 'Next Step' ''.<br />
 +
'''Important: VM will be used in process.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PX26_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Next, choose node and VM to convert.<br />
 +
Fill '' 'Template Friendly Name' '' and press '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PX26_5.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 30px 25px;"|[[File:PX26_6.png]]
 +
|}
 
==Interface==
 
==Interface==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS should look like the one on the screen below. As you can see, control panel contain useful options needed for managing VPS.<br />
+
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below. As you can see, control panel contain useful options needed for managing VPS.<br />
 
Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.<br />
 
Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.<br />
−
Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).
+
Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).<br />
 +
Additionally, your clients are able to access graph of resource usage (9) and view VM history(10).
 
|}
 
|}
 
{|
 
{|
Line 484: Line 561:
 
===VNC Console===
 
===VNC Console===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is VNC console(6) where your clients can remotely manage server. To access it, simply press on the '' 'Console' '' button.<br />
+
|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 />
−
Console requires Java software. You need to accept security risk to run it.
+
To access it, simply press on the '' 'Console' '' button. Console requires Java software. You need to accept security risk to run it.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX28.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX28.png]]
 
|}
 
|}
−
 
 
===Reinstall===
 
===Reinstall===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on '' 'Reinstall' '' (5) button.
+
|style="padding: 10px 0px 20px 15px;"|Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on '' 'Reinstall' ''(5) button.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX29.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX29.png]]
 
|}
 
|}
−
 
 
===Backup Jobs & Backup===
 
===Backup Jobs & Backup===
 
{|
 
{|
−
|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;"|By pressing '' 'Backup Jobs' ''(8) in your client area, you will be carried to backup jobs management page.<br />
−
To add new backup job press '' 'New Job' '' as shown on the following screen.
+
To add a new backup job press '' 'New Job' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
Line 534: Line 609:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In main product page in the client area, under '' 'Details' '' headline your client can find information about current usage of CPU, memory and disk (OpenVZ only).<br />
+
|style="padding: 0px 0px 15px 15px;"|In 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 />
−
Customer can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses' ''.
+
Customers can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses' ''.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX32.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX32.png]]
 
|}
 
|}
−
 
 
===Graphs===
 
===Graphs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under '' 'Details' '' section client can find graph of CPU usage, memory usage, network traffic and disc I/O.<br />
+
|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 />
−
He can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
+
They can also switch timeline of the 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:PX33.png]]
 +
|}
 +
===Task History===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Your clients are able to easily access history of theirs VMs simply by pressing '' 'Task History' ''(10) button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_0.png]]
 +
|}
 +
==IP Manager Integration==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Thanks 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 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 />
 +
2. 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 />
 +
''Note 1: Do not assign Proxmox VPS For WHMCS product to configuration. Simply, create new configuration with assigned IP addresses pool.''<br />
 +
''Note 2: Multiple IP addresses pools can be assigned to one configuration.''<br />
 +
3. In order to finish, go to the Proxmox VPS For WHMCS product → '' 'Module Settings' ''.<br />
 +
Find '' 'IP Manager' '' section and choose previously created pool 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]]
 
|}
 
|}
  
−
==Management of 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 default configurable options.
Line 581: Line 676:
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_4.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX33_4.png]]
 
|}
 
|}
−
 
 
==Management of Billing==
 
==Management of Billing==
 
{|
 
{|
Line 596: Line 690:
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX35.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX35.png]]
 
|}
 
|}
−
 
 
==Management of Existing Accounts==
 
==Management of Existing Accounts==
 
{|
 
{|

Revision as of 14:54, 16 April 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 your servers, IP addresses and clusters.
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!

  • 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 Access
✔ 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)
✔ 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
  • Additionally:
✔ 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:PX1.png
2. Upload and extract the module into the main WHMCS directory.
File:PX2.png
3. When you install Proxmox VPS for the first time you have to rename 'license_RENAME.php' file.

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

File:PX3.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:PX4.png

Activation of Proxmox Addon

5. Firstly we should activate Proxmox Addon.

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

File:PX5.png
6. In 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:PX6.png

Configuration of Server

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

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

File:PX7.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:PX8.png
9. After configuring your server correctly, you will see a following screen.

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

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

Configuration of Product

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

Click on 'Create a New Group' .

File:PX12.png
13. Enter product group name and press 'Save Changes' .
File:PX13.pngress 'Save Changes' .
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:PX14.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:PX15.png
16. Now go to the 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus.

Next, click on 'Save Changes' .

File:PX16.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:PX17.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.

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

If you are using IP Manager For WHMCS you can assign configuration with IPv4 and IPv6 pools at 'IP Manager' section.
For more information, visit IP Manager Integration section.
Additionally, set up backups at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically remove oldest backup as soon as new backup is created and backup limit is reached.

File:PX18 1.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' .
If you are using IP Manager For WHMCS you can assign configuration with IPv4 and IPv6 pools at 'IP Manager' section.
For more information, visit IP Manager Integration section.
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.
Type your VM description in 'Container Description' and press 'Save Changes' .

File:PX19.png
21.Afterwards, press 'Generate default' nearby 'Configurable Options' and 'Custom Fields' .
File:PX19 1.png
By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen 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 product configuration you have to add 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:PX20.png
24. Start of typing desired IP address and mask into 'IP Pool' .

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

File:PX21.png
25. You are now able to create new product using previously added IP address.

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

File:PX22.png
26.The client area of product using OpenVZ virtualization type looks quite similar.
File:PX23.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.
You are also able to add IP address to product. To do so, press 'Add New IP' as shown on the following screen.

File:PX23 5.png
Afterwards, enter IP address in a textbox and confirm through 'Save Changes' .
File:PX23 6.png

Management of Addon

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

To see what product was created and assigned to your Proxmox server simply click on its 'Server Name' .

File:PX24.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:PX25.png
At the 'IP Management' tab you can add, edit and remove IP addresses of Proxmox products.
File:PX26.png
'Clusters' tab contains clusters list. To view information about cluster simply press on its name.
File:PX26 2.png
Here you can find various information about cluster, from available resource to graph of their use.

In order to go back to the cluster list, press on 'Back to clusters list' button.

File:PX26 3.png

Templates Management

You can easily convert any VM at your server to template.

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

File:PX26 4.png
Next, choose node and VM to convert.

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

File:PX26 5.png
To access list of all available templates go to the 'Proxmox Addon' → 'Templates' → 'Show Templates' .
File:PX26 6.png

Interface

Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below. As you can see, control panel contain useful options needed for managing VPS.

Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.
Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).
Additionally, your clients are able to access graph of resource usage (9) and view VM history(10).

File:PX27.png

VNC Console

One of the most interesting functionality is VNC console(6) where your clients can remotely manage their servers.

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

File:PX28.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:PX29.png

Backup Jobs & Backup

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

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

File:PX30.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:PX31.png
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.
File:PX31 2.png
Now choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.

Afterward press 'Add Backup' .

File:PX31 3.png
To restore VM from backup simply press 'Restore' and then click 'OK' button in a popup window to confirm.
File:PX31 4.png
In 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:PX32.png

Graphs

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

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

File:PX33.png

Task History

Your clients are able to easily access history of theirs VMs simply by pressing 'Task History' (10) button.
File:PX33 0.png

IP Manager Integration

Thanks 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 in order to prepare IP addresses pool for Proxmox VPS For WHMCS.
2. Afterwards, create a new configuration and assign previously created pool to it.
Note 1: Do not assign Proxmox VPS For WHMCS product to configuration. Simply, create new configuration with assigned IP addresses pool.
Note 2: Multiple IP addresses pools can be assigned to one configuration.
3. In order to finish, go to the Proxmox VPS For WHMCS product → 'Module Settings' .
Find 'IP Manager' section and choose previously created pool from 'Configuration IPv4' or 'Configuration IPv6' dropdown menu.
Finish through pressing 'Save Changes' .

File:PX33 1 1.png

Configurable Options

When you successfully set up a product, your client can order it by choosing from default configurable options.
File:PX33 1.png
In case those options aren't fitting your needs, you can edit them.

To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

File:PX33 2.png
Here you can view all 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:PX33 3.png
You will see a popup window, so make sure your browser will not block it.

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.
Next, press 'Save Changes' .

File:PX33 4.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 based on the server resources used by them.

File:PX34.png
With Advanced Billing For WHMCS module, you can also display your customers the current server resource usage and their cost.
File:PX35.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 new order with previously created product for your customer. Do not activate product yet.
4. Go to 'Products/Services' section of freshly created product and fill 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 to 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=11269"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Proxmox VE VPS For WHMCS