Proxmox VE VPS For WHMCS
(→Tips) |
|||
Line 281: | Line 281: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/> | |style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/> | ||
− | '' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' | + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' |
|} | |} | ||
{| | {| | ||
Line 294: | Line 294: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''4. Open '' 'UploadOnProxmoxServer' '' and upload content of proper version on all Proxmox servers into '' '/usr/share/novnc-pve/' '' folder.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''4. Open '' 'UploadOnProxmoxServer' '' and upload content of proper version on all Proxmox servers into the '' '/usr/share/novnc-pve/' '' folder.'''<br /> |
− | ''Note: If you wish to allow noVNC consoles, you need to configure product using PVE realm and set user permissions to 'PVEVMUser.' '' | + | ''Note: If you wish to allow noVNC consoles, you need to configure a product using the PVE realm and set user permissions to 'PVEVMUser.' '' |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''5. When you install Proxmox VPS For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''5. When you install Proxmox VPS For WHMCS for the first time you have to rename the '' 'license_RENAME.php' '' file.'''<br /> |
File is located in '' 'modules/servers/proxmoxVPS/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | File is located in '' 'modules/servers/proxmoxVPS/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | ||
|} | |} | ||
Line 316: | Line 316: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|'''7. Firstly, activate Proxmox Addon.''' <br /> | |style="padding: 10px 0px 15px 15px;"|'''7. Firstly, activate Proxmox Addon.''' <br /> | ||
− | To do so, log in | + | To do so, log in to your WHMCS and press '' 'Setup' '' → '' 'Addon Modules'. '' Find '' 'Proxmox Addon' '' and press '' 'Activate'. '' |
|} | |} | ||
{| | {| | ||
Line 323: | Line 323: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''8. 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 the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 332: | Line 332: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|'''9. Now, we will show you how to configure a new product.''' <br /> | |style="padding: 10px 0px 15px 15px;"|'''9. Now, we will show you how to configure a new product.''' <br /> | ||
− | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button. | + | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press the '' 'Add New Server' '' button. |
|} | |} | ||
{| | {| | ||
Line 339: | Line 339: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''10. Next, enter your server name, IP address, username and password.<br /> | |style="padding: 0px 0px 15px 15px;"|'''10. Next, enter your server name, IP address, username and password.<br /> | ||
− | Choose authentication type from '' 'Authentication' '' and '' 'Proxmox VPS' '' from '' 'Type' '' dropdown menus. '' 'Save Changes'. ''''' | + | Choose an authentication type from '' 'Authentication' '' and '' 'Proxmox VPS' '' from '' 'Type' '' dropdown menus. '' 'Save Changes'. ''''' |
|} | |} | ||
{| | {| | ||
Line 345: | Line 345: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''11. After configuring your server correctly, you will see | + | |style="padding: 0px 0px 15px 15px;"|'''11. After configuring your server correctly, you will see the following screen.''' <br /> |
− | In order to check connection | + | In order to check connection to a Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below. |
|} | |} | ||
{| | {| | ||
Line 358: | Line 358: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''13. Enter name, click on your previously created server, press '' 'Add' '' and | + | |style="padding: 0px 0px 20px 15px;"|'''13. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes'. ''''' |
|} | |} | ||
{| | {| | ||
Line 373: | Line 373: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''15. Enter product group name and press '' 'Save Changes'. ''''' | + | |style="padding: 0px 0px 20px 15px;"|'''15. Enter a product group name and press '' 'Save Changes'. ''''' |
|} | |} | ||
{| | {| | ||
Line 386: | Line 386: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''17. | + | |style="padding: 0px 0px 15px 15px;"|'''17. Afterward, choose your product group and its type from dropdown menus, enter your product name and press '' 'Continue'. '''''<br /> |
'' 'Product Type' '' can be set to '' 'Dedicated/VPS Server' '' but nameservers will have to be added later.<br/> | '' 'Product Type' '' can be set to '' 'Dedicated/VPS Server' '' but nameservers will have to be added later.<br/> | ||
− | If you do not want to be forced to fill out nameservrs, please select | + | If you do not want to be forced to fill out nameservrs, please select '' 'Hosting Account' here. '' |
|} | |} | ||
{| | {| | ||
Line 394: | Line 394: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''18. 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;"|'''18. Now go to the '' 'Module Settings' '' section, choose both '' 'Proxmox VPS' '' and your previously created server group from dropdown menus.<br /> |
Next, '' 'Save Changes'. ''''' | Next, '' 'Save Changes'. ''''' | ||
|} | |} | ||
Line 406: | Line 406: | ||
'''LXC''' ''(supported by Proxmox VE 4.0 and later)''<br/> | '''LXC''' ''(supported by Proxmox VE 4.0 and later)''<br/> | ||
'''OpenVZ''' ''(supported by Proxmox VE 3.4 and earlier, prior to Proxmox v2.3.0)''<br/> | '''OpenVZ''' ''(supported by Proxmox VE 3.4 and earlier, prior to Proxmox v2.3.0)''<br/> | ||
− | You can also choose how often bandwidth usage should be counted.<br /> | + | You can also choose how often the bandwidth usage should be counted.<br /> |
− | + | Afterward, press '' 'Save Changes'.''<br /> | |
− | ''Note: If you choose 'Auto-Node' as | + | ''Note: If you choose the 'Auto-Node' as your 'Default Note', new virtual servers will be created on the least used node.'' |
|} | |} | ||
{| | {| | ||
Line 414: | Line 414: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''20. Setting KVM virtualization type (skip, if you have chosen LXC virtualization type).'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''20. Setting the KVM virtualization type (skip, if you have chosen the LXC 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.<br /> | Type your VM description in '' 'Container Description' '' and scroll down.<br /> | ||
− | You can also define VM prefix by filling | + | You can also define VM prefix by filling out the '' 'Default KVM Container Prefix' '' field.<br/> |
Set '' 'Use Client name For VPS' '' to '' 'Yes' '' and either the client's company or their first/last name will be used as the hostname value. <br/> | Set '' 'Use Client name For VPS' '' to '' 'Yes' '' and either the client's company or their first/last name will be used as the hostname value. <br/> | ||
− | Here you may also decide whether you wish to use DHCP software to automatically assign IP addresses, simply select option '' 'ISC DHCP Server'. '' Read more about its installation [http://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#Automatic_IP_Address_Assignment here]. | + | Here you may also decide whether you wish to use DHCP software to automatically assign IP addresses, simply select the option '' 'ISC DHCP Server'. '' Read more about its installation [http://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#Automatic_IP_Address_Assignment here]. |
|} | |} | ||
{| | {| | ||
Line 426: | Line 426: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''21. 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;"|'''21. Now, select desired values from '' 'Storage', 'Disk Type', 'CD/DVD-ROM Type', 'ISO Image', 'Network Mode' '' and'' 'Network Model'.'''''<br /> | ||
− | Additionally, set up backups in '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br /> | + | Additionally, set up backups in the '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br /> |
Backups routing automatically removes the oldest backup as soon as a new backup is created and a backup limit is reached.<br /> | 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 '' 'Store The Backup For N Days' '' to remove backups older than the provided number of days.<br /> | Type in the number of days into '' 'Store The Backup For N Days' '' to remove backups older than the provided number of days.<br /> | ||
− | In '' 'Firewall Options' '' section you can set up available interfaces and firewall rules limit.<br /> | + | In the '' 'Firewall Options' '' section you can set up available interfaces and a firewall rules limit.<br /> |
'''Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.'''<br /> | '''Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.'''<br /> | ||
'''If you want be able to set your own password on KVM virtualization go check the [https://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#Configuration_of_SSH_Keys_.28KVM.29 Configuration of SSH Keys] section.''' | '''If you want be able to set your own password on KVM virtualization go check the [https://www.docs.modulesgarden.com/Proxmox_VPS_For_WHMCS#Configuration_of_SSH_Keys_.28KVM.29 Configuration of SSH Keys] section.''' | ||
Line 437: | Line 437: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''22. Setting | + | |style="padding: 0px 0px 15px 15px;"|'''22. Setting the LXC virtualization type (skip, if you have chosen the KVM virtualization type).'''<br/> |
From dropdown menus choose '' 'Default Storage' '', '' 'Template' '' and '' 'Bridge'. ''<br /> | From dropdown menus choose '' 'Default Storage' '', '' 'Template' '' and '' 'Bridge'. ''<br /> | ||
Enter your virtual servers description in '' 'Container Description' '' and press '' 'Save Changes'. ''<br/> | Enter your virtual servers description in '' 'Container Description' '' and press '' 'Save Changes'. ''<br/> | ||
'''Remember! This virtualization type is supported only by Proxmox VE 4.0. and later'''<br/> | '''Remember! This virtualization type is supported only by Proxmox VE 4.0. and later'''<br/> | ||
− | If you are using older version of Proxmox server, you will not be able to start this virtualization. | + | If you are using older version of a Proxmox server, you will not be able to start this virtualization. |
|} | |} | ||
{| | {| | ||
Line 447: | Line 447: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''23. Setting | + | |style="padding: 0px 0px 15px 15px;"|'''23. Setting the OpenVZ virtualization type (skip, if you have chosen the KVM virtualization type).'''<br /> |
'' '''Please note''' that only versions of Proxmox '''prior to v.2.3.0''' support OpenVZ virtualization.''<br/> | '' '''Please note''' that only versions of Proxmox '''prior to v.2.3.0''' support OpenVZ virtualization.''<br/> | ||
From dropdown menus choose '' 'Default Storage' '' and '' 'OpenVZ OS Template'. ''<br /> | From dropdown menus choose '' 'Default Storage' '' and '' 'OpenVZ OS Template'. ''<br /> | ||
− | Additionally, define backup settings at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br /> | + | Additionally, define backup settings at the '' 'Backups' '' section through selecting values from the '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br /> |
Backups routing automatically deletes the oldest backup when a new backup is created and a backup limit is reached.<br /> | Backups routing automatically deletes the oldest backup when a new backup is created and a backup limit is reached.<br /> | ||
− | Fill | + | Fill out the number of days into '' 'Store The Backup For N Days' '' to remove backups older than the provided number of days.<br /> |
Type your VM description into '' 'Container Description' '' and press '' 'Save Changes'.'' | Type your VM description into '' 'Container Description' '' and press '' 'Save Changes'.'' | ||
|} | |} | ||
Line 460: | Line 460: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''24. | + | |style="padding: 0px 0px 20px 15px;"|'''24.Afterward, press '' 'Generate default' '' nearby '' 'Configurable Options' '' and '' 'Custom Fields'. ''''' |
|} | |} | ||
{| | {| | ||
Line 467: | Line 467: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 15px;"|By doing so, you have just added required custom fields and optional configurable options listed in [[Proxmox_VPS_For_WHMCS#List_of_Configurable_Options|this table]].<br/> | |style="padding: 0px 0px 20px 15px;"|By doing so, you have just added required custom fields and optional configurable options listed in [[Proxmox_VPS_For_WHMCS#List_of_Configurable_Options|this table]].<br/> | ||
− | '' Note that while generating 'Configurable Options' it is advisable to delete the ones you | + | '' Note that while generating 'Configurable Options' it is advisable to delete the ones you no longer use, e.g. for the KVM virtualization delete swap option or IPv6.'' |
|} | |} | ||
{| | {| | ||
Line 481: | Line 481: | ||
==Configuration of Addon== | ==Configuration of Addon== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|'''26. Proceed to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Settings' '' → '' 'General Settings' '' and set up cron jobs listed under '' 'Cron' '' section. | + | |style="padding: 10px 0px 20px 15px;"|'''26. Proceed to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Settings' '' → '' 'General Settings' '' and set up cron jobs listed under the '' 'Cron' '' section. |
|} | |} | ||
{| | {| | ||
Line 488: | Line 488: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''27. Adding a new IP address (if you are not using [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS]).'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''27. Adding a 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 a new product you have to add | + | In order to create a new product you have to add '' 'Dedicated IP'' ' to the '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br /> |
To do so, go to '' 'IP Management' '' and press '' 'Add Pool'. ''<br /> | To do so, go to '' 'IP Management' '' and press '' 'Add Pool'. ''<br /> | ||
− | ''Note: You can add both IPv4 and IPv6 addresses.'' | + | ''Note: You can add both the IPv4 and IPv6 addresses.'' |
|} | |} | ||
{| | {| | ||
Line 496: | Line 496: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''28. Start by typing desired IP address and mask into '' 'IP Pool'. '''''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''28. Start by typing a desired IP address and mask into '' 'IP Pool'. '''''<br /> |
− | Next, choose a server from | + | Next, choose a server from the '' 'Server' '' dropdown menu and define which virtualization it should be applied to through selecting it from the '' 'Virtualization' '' dropdown menu.<br /> |
− | + | Afterward, press '' 'Add'. ''<br/> | |
''Note! Automatic IP assignment works only for OpenVZ/LXC machines.''<br/> | ''Note! Automatic IP assignment works only for OpenVZ/LXC machines.''<br/> | ||
− | ''KVM virtualization does not support IP Management from module. Instead, IP can be assigned via the console.'' | + | ''KVM virtualization does not support IP Management from the module. Instead, IP can be assigned via the console.'' |
|} | |} | ||
{| | {| | ||
Line 507: | Line 507: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''29. You are now able to create a new product using the previously added IP address.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''29. You are now able to create a new product using the previously added IP address.'''<br /> | ||
− | If you | + | If you are using the KVM virtualization type, the client area in a successfully created product should look similar to the one on the screen below. |
|} | |} | ||
{| | {| | ||
Line 513: | Line 513: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''30.The client area with | + | |style="padding: 0px 0px 20px 15px;"|'''30.The client area with the LXC virtualization type product looks quite similar.''' |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_25.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_25.png]] | ||
|} | |} | ||
+ | |||
==Configuration of SSH Keys (KVM)== | ==Configuration of SSH Keys (KVM)== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''SSH keys are required to enable the automatic resizing of partition upon the disk upgrade as well as the change of passwords for KVM virtualization type.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''SSH keys are required to enable the automatic resizing of partition upon the disk upgrade as well as the change of passwords for the KVM virtualization type.'''<br /> |
'' '''Note''' - 'Resize Partition' and 'Change Root Password' will only work for '''newly created VMs with ISC DHCP and Internet access configuration'''. We recommend using this option only for new products.'' | '' '''Note''' - 'Resize Partition' and 'Change Root Password' will only work for '''newly created VMs with ISC DHCP and Internet access configuration'''. We recommend using this option only for new products.'' | ||
|} | |} | ||
Line 534: | Line 535: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''32. Next, while in your WHMCS, go to | + | |style="padding: 0px 0px 20px 15px;"|'''32. Next, while in your WHMCS, go to '' 'Proxmox Addon' '' → '' 'Settings' '' → '' 'SSH Keys' '' and press the '' 'Add' '' button.''' |
|} | |} | ||
{| | {| | ||
Line 540: | Line 541: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|'''33. Enter | + | |style="padding: 0px 0px 20px 15px;"|'''33. Enter a name and location to the key pairs located on your WHMCS server.''' |
|} | |} | ||
{| | {| | ||
Line 552: | Line 553: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''35. Now, '' 'Resize Partition' '' and '' 'Change Root Password' '' options should be available.''' | + | |style="padding: 0px 0px 15px 15px;"|'''35. Now, the '' 'Resize Partition' '' and '' 'Change Root Password' '' options should be available.''' |
− | * ''' Resize Partition ''' - if a customer upgrades a VM by changing the disk size to a larger one, the size of the last partition in that disk will be automatically increased | + | * ''' Resize Partition ''' - if a customer upgrades a VM by changing the disk size to a larger one, the size of the last partition in that disk will be automatically increased by the newly added value. <br /> The feature deletes a current partition table, then creates a new one, according to a new disk size, and reboots the VM. <br/>These partition types have to be standard, e.g. '' 'Linux Extended' (Ext2/Ext3/Ext4...), 'Linux SWAP' '' or '' 'Solaris' ''. <br/>'' 'LVM' '' partitions are '''not''' yet supported ''(coming soon)''.'' '''<br/> Important - in case of any failure, all data available on the resized partition might be lost!''' '' |
− | * ''' Change Root Password ''' - this option is responsible for the automatic reset of | + | * ''' Change Root Password ''' - this option is responsible for the automatic reset of the password after the VM creation. It also allows users to generate a new root password while using the VM. |
− | '' '''Note''' - if a customer decides to remove the public key from VM on their own, it will render the 'Resize Partition' and 'Change Root Password' options no longer working!'' | + | '' '''Note''' - if a customer decides to remove the public key from the VM on their own, it will render the 'Resize Partition' and 'Change Root Password' options no longer working!'' |
<br /><br /> | <br /><br /> | ||
From now on, all passwords for the newly created VMs will be generated automatically by WHMCS. The partition will be also automatically resized during the VM creation if a disk size is different than the one set as default in the template.<br /> | From now on, all passwords for the newly created VMs will be generated automatically by WHMCS. The partition will be also automatically resized during the VM creation if a disk size is different than the one set as default in the template.<br /> | ||
− | What is more, the administrator will be able to execute the action of partition resizing during the package change (if the disk size has been previously upgraded) and also set a custom root password in '' 'Product/Services' '' settings. | + | What is more, the administrator will be able to execute the action of partition resizing during the package change (if the disk size has been previously upgraded) and also set a custom root password in the '' 'Product/Services' '' settings. |
|} | |} | ||
{| | {| | ||
Line 584: | Line 585: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|Afterward, enter IP address in a textbox and confirm through pressing '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 613: | Line 614: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|Through pressing '' 'Edit' '' you will be moved to server edit page. | + | |style="padding: 0px 0px 30px 15px;"|Through pressing '' 'Edit' '' you will be moved to the server edit page. |
|} | |} | ||
====VMs List==== | ====VMs List==== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Servers' '' → '' 'VMs List' '' you can find details | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Servers' '' → '' 'VMs List' '' you can find details of any proxmox product.<br /> |
|} | |} | ||
{| | {| | ||
Line 624: | Line 625: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Use '' 'Toggle Filters' '' button to find entries you are the most interested in. | + | |style="padding: 0px 0px 20px 15px;"|Use the '' 'Toggle Filters' '' button to find entries you are the most interested in. |
|} | |} | ||
{| | {| | ||
Line 642: | Line 643: | ||
===IP Management=== | ===IP Management=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|At '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products. | + | |style="padding: 10px 0px 20px 15px;"|At the '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products. |
|} | |} | ||
{| | {| | ||
Line 653: | Line 654: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_30_1.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_30_1.png]] | ||
|} | |} | ||
+ | |||
===Automatic IP Address Assignment=== | ===Automatic IP Address Assignment=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 5px 15px;"|Automatic IP address assignment can be applied to your Proxmox module, all you need to do is | + | |style="padding: 10px 0px 5px 15px;"|Automatic IP address assignment can be applied to your Proxmox module, all you need to do is install '' 'DHCP' (Dynamic Host Configuration Protocol) ''<br/> and IP addresses will be automatically requested from a DHCP server. Consequently, the need to manually configure them will be reduced to a minimum. <br/>'''''Important! This option is available only for the 'KVM' virtualization type.'''''<br/>When there are no IP addresses assigned to the module, then it will create a VM without any IP address. In that case, you should verify the configuration of your IP Manager, <br/> after that you are allowed to run the 'Change Package' command in order to assign IP addresses.<br/> <br/> Read the below section to learn how to properly install and configure DHCP.<br/> |
+ | |||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|1. First of all, you must install SSH2 package on your WHMCS server. Find precise instructions on how to do that [http://php.net/manual/en/ssh2.installation.php here].<br/> | + | |style="padding: 0px 0px 5px 15px;"|1. First of all, you must install the SSH2 package on your WHMCS server. Find precise instructions on how to do that [http://php.net/manual/en/ssh2.installation.php here].<br/> |
− | :''Please note that in order to use ISC DHCP, root details must be | + | :''Please note that in order to use ISC DHCP, root details must be provided in the server configuration settings.'' |
|} | |} | ||
{| | {| | ||
Line 688: | Line 691: | ||
*Key words: '''''#ProxmoxIPv6 #ProxmoxIPv4''''' suggesting the usage of a specific type of IP address, must be located in the one of above mentioned files.<br/> | *Key words: '''''#ProxmoxIPv6 #ProxmoxIPv4''''' suggesting the usage of a specific type of IP address, must be located in the one of above mentioned files.<br/> | ||
− | :''Note: Only key word corresponding to | + | :''Note: Only a key word corresponding to the used IP type is required. If you do not use IPv6 then /etc/dhcp/dhcpd6.conf configuration and #ProxmoxIPv6 key word are not obligatory.'' |
*More info about configuring DHCP server can be found [http://askubuntu.com/questions/140126/how-do-i-configure-a-dhcp-server here]. | *More info about configuring DHCP server can be found [http://askubuntu.com/questions/140126/how-do-i-configure-a-dhcp-server here]. | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 5px 15px;"|3. Turn on ISC DHCP. | |style="padding: 0px 0px 5px 15px;"|3. Turn on ISC DHCP. | ||
− | To use automatic IP addresses assignment feature, select '' 'ISC DHCP Server' '' option in '' 'Module Settings' '' under '' 'KVM Configuration' '' section. | + | To use the automatic IP addresses assignment feature, select '' 'ISC DHCP Server' '' option in '' 'Module Settings' '' under the '' 'KVM Configuration' '' section. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX_48_1.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX_48_1.png]] | ||
|} | |} | ||
+ | |||
===IP Manager Integration=== | ===IP Manager Integration=== | ||
{| | {| | ||
|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 subnets with 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 subnets with IP addresses and assign them to desired products.<br/> | ||
− | '' '''Note:''' This integration works for '''LXC''' and '''KVM''' virtualization type. '''OpenVZ''' is no | + | By activating the IP Manager submodule, settings concerning IP adresses such as 'Configurable Options' and 'Default Options' are ignored by Proxmox VPS.<br/> |
+ | '' '''Note:''' This integration works for '''LXC''' and '''KVM''' virtualization type. '''OpenVZ''' is no longer supported.'' | ||
<br/><br/> | <br/><br/> | ||
− | 1. Proceed to IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Subnets Subnets] tab in order to prepare IP addresses subnet for Proxmox VPS For WHMCS.<br/> | + | 1. Proceed to the IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Subnets Subnets] tab in order to prepare IP addresses subnet for Proxmox VPS For WHMCS.<br/> |
− | 2. Edit | + | 2. Edit the previously created IP addresses subnet and create a custom field '' 'MAC Address' '' with a desired MAC address at each IP address in the subnet.<br/> |
''' ''Note:'' Setting up MAC address is optional and can be skipped.'''<br/> | ''' ''Note:'' Setting up MAC address is optional and can be skipped.'''<br/> | ||
More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Default_Custom_Fields here]. | More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Default_Custom_Fields here]. | ||
Line 712: | Line 717: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|3. | + | |style="padding: 0px 0px 15px 15px;"|3. Afterward, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign the previously created subnet to it.<br /> |
''Note: Multiple IP addresses subnets can be assigned to a single configuration.''<br /> | ''Note: Multiple IP addresses subnets can be assigned to a single configuration.''<br /> | ||
4. Now, link the configuration with Proxmox VPS product via a product, a server or a configurable option.<br /> | 4. Now, link the configuration with Proxmox VPS product via a product, a server or a configurable option.<br /> | ||
− | On the following screen we have linked them via configurable option assigned to Proxmox VPS product. | + | On the following screen we have linked them via the configurable option assigned to the Proxmox VPS product. |
|} | |} | ||
{| | {| | ||
Line 721: | Line 726: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|5. Now, enable integration by proceeding to '' '3rd Party Integration' '' tab.<br /> | + | |style="padding: 0px 0px 15px 15px;"|5. Now, enable the integration by proceeding to the '' '3rd Party Integration' '' tab.<br /> |
− | Press '' 'Activate' '' next to '' 'proxmoxVPS' '' module type as shown on the following screen. | + | Press '' 'Activate' '' next to the '' 'proxmoxVPS' '' module type as shown on the following screen. |
|} | |} | ||
{| | {| | ||
Line 728: | Line 733: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|6. Next, assign | + | |style="padding: 0px 0px 15px 15px;"|6. Next, assign the previously created configuration to the submodule.<br /> |
− | Press '' 'Configure' '', choose | + | Press '' 'Configure' '', choose a configuration and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 735: | Line 740: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|In case | + | |style="padding: 0px 0px 15px 15px;"|In case you encounter an error like on the below screen while integrating the two products, probably the function '' 'mb_strlen' '' is not enabled by default.<br/> Please read the manual [http://www.php.net/manual/en/mbstring.installation.php here] for installation instructions. |
|} | |} | ||
{| | {| | ||
Line 743: | Line 748: | ||
===Clusters=== | ===Clusters=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|'' 'Clusters' '' tab contains the list of clusters. To view information about a cluster simply press its name. | + | |style="padding: 10px 0px 20px 15px;"| The '' 'Clusters' '' tab contains the list of clusters. To view information about a cluster simply press its name. |
|} | |} | ||
{| | {| | ||
Line 754: | Line 759: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_32.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_32.png]] | ||
|} | |} | ||
+ | |||
===Templates List=== | ===Templates List=== | ||
{| | {| | ||
Line 765: | Line 771: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM on your server to a 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 '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template'. ''<br /> | + | In order to convert a VM, go to '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template'. ''<br /> |
− | Choose server on which VM to convert exists and press '' 'Next Step'. ''<br /> | + | Choose a server on which the VM to convert exists and press '' 'Next Step'. ''<br /> |
'''Important: VM will be destroyed in the process.''' | '''Important: VM will be destroyed in the process.''' | ||
|} | |} | ||
Line 773: | Line 779: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Next, choose node and VM to convert.<br /> | + | |style="padding: 0px 0px 15px 15px;"|Next, choose a node and VM to convert.<br /> |
− | Fill | + | Fill out '' 'Template Friendly Name' '' and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_34.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_34.png]] | ||
|} | |} | ||
+ | |||
===General Settings=== | ===General Settings=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'' 'Minimum VMID' '' allows you to define minimal ID of VM created | + | |style="padding: 10px 0px 15px 15px;"|'' 'Minimum VMID' '' allows you to define a minimal ID of a VM created on the server, which does not have any VMID range defined.<br /> |
− | Cron job user synchronization - if you change user role in the product settings, this cron job changes the roles of existing users.<br/> | + | Cron job user synchronization - if you change a user role in the product settings, this cron job changes the roles of existing users.<br/> |
− | Cron job recovery VM synchronization - | + | Cron job recovery VM synchronization - runs regularly, responsible for updating list of recovered VMs, allows downloading results. |
|} | |} | ||
{| | {| | ||
Line 791: | Line 798: | ||
===VM Cleaner=== | ===VM Cleaner=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|VM Cleaner allows you to track | + | |style="padding: 10px 0px 20px 15px;"|VM Cleaner allows you to track VMs existing only on your Proxmox server and that are not visible in your WHMCS.<br/> Consequently, you are allowed to sort and delete only those VMs that cannot be managed from your WHMCS. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_35_1.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_35_1.png]] | ||
|} | |} | ||
+ | |||
===SSH Keys=== | ===SSH Keys=== | ||
{| | {| | ||
Line 809: | Line 817: | ||
{| | {| | ||
|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 options useful for managing VM.<br /> | + | As you can see, control panel contains options useful for managing a VM.<br /> |
The module allows your customers to easily '' 'boot', 'reboot', 'stop' '' and '' 'shutdown' '' their servers through pressing specific buttons.<br /> | The module allows your customers to easily '' 'boot', 'reboot', 'stop' '' and '' 'shutdown' '' their servers through pressing specific buttons.<br /> | ||
− | Clients can also access '' 'noVNC' '' and '' 'SPICE' '' consoles. Among '' 'Additional Tools' '' you will find options to '' 'reinstall' '' server, create '' 'backup' '' and set up '' 'backup jobs'.''<br /> | + | Clients can also access the '' 'noVNC' '' and '' 'SPICE' '' consoles. Among '' 'Additional Tools' '' you will find options to '' 'reinstall' '' server, create '' 'backup' '' and set up '' 'backup jobs'.''<br /> |
<br/> | <br/> | ||
Your clients are able to access resource usage '' 'graphs','' view VM '' 'history','' manage '' 'network' '' interface device and set up '' 'firewall' '' rules.<br/> | Your clients are able to access resource usage '' 'graphs','' view VM '' 'history','' manage '' 'network' '' interface device and set up '' 'firewall' '' rules.<br/> | ||
Line 820: | Line 828: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|On the main product page in the client area, under '' 'Details' '' headline your clients can find information about current usage of CPU, memory, disk (LXC only)<br/> and SWAP (LXC only). | + | |style="padding: 0px 0px 15px 15px;"|On the main product page in the client area, under the '' 'Details' '' headline your clients can find information about current usage of CPU, memory, disk (LXC only)<br/> and SWAP (LXC only). |
Customers can also view '' 'DNS' '' (LXC only) and '' 'IP Addresses'. '' | Customers can also view '' 'DNS' '' (LXC only) and '' 'IP Addresses'. '' | ||
|} | |} | ||
Line 838: | Line 846: | ||
===noVNC Console=== | ===noVNC Console=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|noVNC console allows your clients to connect | + | |style="padding: 10px 0px 20px 15px;"|noVNC console allows your clients to connect to their server in the easiest possible way. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_39_1.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_39_1.png]] | ||
|} | |} | ||
+ | |||
===SPICE Console=== | ===SPICE Console=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|SPICE console enables you to connect | + | |style="padding: 10px 0px 15px 15px;"|SPICE console enables you to connect to virtual machine using SPICE.<br /> |
− | ''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.'' | + | ''Note: Your client needs to [http://www.spice-space.org/download.html download] and install client side SPICE application in order to connect with a VM.'' |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:PX2_40.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_40.png]] | ||
|} | |} | ||
+ | |||
==Client Area - Additional Tools== | ==Client Area - Additional Tools== | ||
===Reinstall=== | ===Reinstall=== | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Reinstall feature should be used to change templates. Select template from available templates list to reinstall your server, click '' 'Reinstall' '' button. | + | |style="padding: 0px 0px 20px 15px;"|Reinstall feature should be used to change templates. Select template from available templates list to reinstall your server, click the '' 'Reinstall' '' button. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_38.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_38.png]] | ||
|} | |} | ||
+ | |||
===Backups=== | ===Backups=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|To create a single backup, press '' 'Backups' '' button and click on '' 'New Backup' '' as shown on the following screen. | + | |style="padding: 10px 0px 20px 15px;"|To create a single backup, press the '' 'Backups' '' button and click on '' 'New Backup' '' as shown on the following screen. |
|} | |} | ||
{| | {| | ||
Line 869: | Line 880: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Now, choose '' 'Compress Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br /> | |style="padding: 0px 0px 15px 15px;"|Now, choose '' 'Compress Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br /> | ||
− | + | Afterward, press '' 'Add'. '' | |
|} | |} | ||
{| | {| | ||
Line 875: | Line 886: | ||
|} | |} | ||
{| | {| | ||
− | |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 15px;"|To restore a VM from backup, press '' 'Restore' '' and then click the '' 'OK' '' button in a popup window to confirm. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_43.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_43.png]] | ||
|} | |} | ||
+ | |||
===Backup Jobs=== | ===Backup Jobs=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' '' in your client area, you will be carried to | + | |style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' '' in your client area, you will be carried to the backup jobs management page.<br /> |
There you can easily edit/delete and preview details of existing backup jobs.<br /> | There you can easily edit/delete and preview details of existing backup jobs.<br /> | ||
To add a 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 890: | Line 902: | ||
|} | |} | ||
{| | {| | ||
− | |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: 0px 0px 15px 15px;"|Now, define a backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br /> |
− | Next, press '' 'Add' '' button. | + | Next, press the '' 'Add' '' button. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_45.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_45.png]] | ||
|} | |} | ||
+ | |||
===Graphs=== | ===Graphs=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Through pressing '' 'Graphs' '' button clients will be moved to the page with generated graphs of CPU usage, memory usage, network traffic and disc I/O.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Through pressing the '' 'Graphs' '' button clients will be moved to the page with generated graphs of CPU usage, memory usage, network traffic and disc I/O.<br /> |
They can also switch the timeline of graphs by choosing it from a dropdown menu pointed on the following screen. Choose from '' 'Hour', 'Day', 'Week', 'Moth' '' and '' 'Year'. '' | They can also switch the timeline of graphs by choosing it from a dropdown menu pointed on the following screen. Choose from '' 'Hour', 'Day', 'Week', 'Moth' '' and '' 'Year'. '' | ||
|} | |} | ||
Line 904: | Line 917: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_46.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_46.png]] | ||
|} | |} | ||
+ | |||
===Task History=== | ===Task History=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|To access history of VM, simply press '' 'Task History' '' button. | + | |style="padding: 10px 0px 20px 15px;"|To access the history of a VM, simply press the '' 'Task History' '' button. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_47.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_47.png]] | ||
|} | |} | ||
+ | |||
===Network=== | ===Network=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Your clients are allowed to add/remove only private network interface | + | |style="padding: 10px 0px 15px 15px;"|Your clients are allowed to add/remove only private network interface devices.<br/> |
Keep in mind that '' ' Network device' '' options must be set as '' 'Private'.'' | Keep in mind that '' ' Network device' '' options must be set as '' 'Private'.'' | ||
|} | |} | ||
Line 922: | Line 937: | ||
===Snapshots (KVM only)=== | ===Snapshots (KVM only)=== | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Use snapshot to remember | + | |style="padding: 0px 0px 20px 15px;"|Use a snapshot to remember a current state contents of the virtual machine memory. You may use them later to restore the VM's settings. |
|} | |} | ||
{| | {| | ||
Line 928: | Line 943: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Press '' 'Take Snapshot' '' button and fill out the form to take a snapshot.<br/> Name it (use alphabetical characters only), choose whether to include RAM and add | + | |style="padding: 0px 0px 20px 15px;"|Press the '' 'Take Snapshot' '' button and fill out the form to take a snapshot.<br/> Name it (use alphabetical characters only), choose whether to include RAM and add a description. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PX2_48_5.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_48_5.png]] | ||
|} | |} | ||
+ | |||
===Firewall=== | ===Firewall=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Owing to '' 'Firewall' '' page, your clients can set up firewall rules and enable security group for their servers from your WHMCS client area.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Owing to the '' 'Firewall' '' page, your clients can set up firewall rules and enable a security group for their servers from your WHMCS client area.<br /> |
− | As you can see, you can easily modify and remove | + | As you can see, you can easily modify and remove previously added rules and security groups.<br /> |
To add a new firewall rule (1) or predefined security group (2) use the buttons marked on the following screen. | To add a new firewall rule (1) or predefined security group (2) use the buttons marked on the following screen. | ||
|} | |} | ||
Line 943: | Line 959: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|You can add a firewall rule in two ways. Both of them require choosing direction, action, interface, source and destination.<br /> | + | |style="padding: 0px 0px 15px 15px;"|You can add a firewall rule in two ways. Both of them require choosing a direction, action, interface, source and a destination.<br /> |
− | The first way (red) is by choosing macro from | + | The first way (red) is by choosing macro from the '' 'Macro' '' dropdown field.<br /> |
− | The second way (blue) consists of choosing protocol and filling source and destination ports out.<br /> | + | The second way (blue) consists of choosing a protocol and filling both source and destination ports out.<br /> |
− | Additionally, you can enable rule and add a comment to it.<br /> | + | Additionally, you can enable a rule and add a comment to it.<br /> |
Press '' 'Add' '' to create a rule. | Press '' 'Add' '' to create a rule. | ||
|} | |} | ||
Line 953: | Line 969: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|Choose a security group and an interface on which the group will be used.<br /> |
− | Additionally, you can enable security group and add a comment to it.<br /> | + | Additionally, you can enable a security group and add a comment to it.<br /> |
Click '' 'Add' '' to use the security group. | Click '' 'Add' '' to use the security group. | ||
|} | |} | ||
Line 978: | Line 994: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|In case those options do not suit your needs, you can edit them.<br /> | |style="padding: 0px 0px 15px 15px;"|In case those options do not suit your needs, you can edit them.<br /> | ||
− | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' '' and press edit button next to the configurable option used by your product. | + | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' '' and press the edit button next to the configurable option used by your product. |
|} | |} | ||
{| | {| | ||
Line 985: | Line 1,001: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Here you can view all the 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 a 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 the edit button as shown on the screen below. |
|} | |} | ||
{| | {| | ||
Line 1,002: | Line 1,018: | ||
{| | {| | ||
|style="padding: 0px 0px 5px 15px;"| | |style="padding: 0px 0px 5px 15px;"| | ||
− | The table below lists all | + | The table below lists all configurable options used by the module for the chosen virtualization type.<br/> |
− | Note that the name on the left is a variable (which you <u>should not edit</u>) separated by the | from editable custom name. | + | Note that the name on the left is a variable (which you <u>should not edit</u>) separated by the | from the editable custom name. |
|} | |} | ||
{| class="wikitable" style="margin-left: 25px; margin-bottom: 30px" | {| class="wikitable" style="margin-left: 25px; margin-bottom: 30px" | ||
Line 1,066: | Line 1,082: | ||
|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 basing on the server resources used by them.<br/> | Module allows you to charge your customers basing on the server resources used by them.<br/> | ||
− | '' Note: Advanced Billing supports '''OpenVZ''' (prior to Proxmox v2.3.0), '''KVM''' and '''LXC''' virtualization type. | + | '' Note: Advanced Billing supports '''OpenVZ''' (prior to Proxmox v2.3.0), '''KVM''' and the '''LXC''' virtualization type. |
|} | |} | ||
{| | {| | ||
Line 1,083: | Line 1,099: | ||
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 a new order with a 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 the product yet.'''<br /> |
− | 4. Access the just created product from the admin area via client profile → '' 'Products/Services' '' section and fill | + | 4. Access the just created product from the admin area via client profile → '' 'Products/Services' '' section and fill out 4 custom fields.<br /> |
They are '' 'vmid' '' and '' 'node' ''. ''<br /> | They are '' 'vmid' '' and '' 'node' ''. ''<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 /> | + | 6. Set the product status to '' 'Active' ''.<br /> |
− | '''Remember, do not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.''' | + | '''Remember, do not click the '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.''' |
|} | |} | ||
+ | |||
==Servers Location Management== | ==Servers Location Management== | ||
{| | {| | ||
Line 1,096: | Line 1,113: | ||
1. In your product's '' 'Module Settings' '' set up '' 'Default Node' '' to '' 'Server-Node'. ''<br/> | 1. In your product's '' 'Module Settings' '' set up '' 'Default Node' '' to '' 'Server-Node'. ''<br/> | ||
2. Create a WHMCS server for each Proxmox node.<br/> | 2. Create a WHMCS server for each Proxmox node.<br/> | ||
− | 3. Manually create configurable option, name it for example: '' 'Location'. '' Add options for each server within that config option.<br/> | + | 3. Manually create a configurable option, name it for example: '' 'Location'. '' Add options for each server within that config option.<br/> |
4. Install our Server Allocator For WHMCS module and configure it properly. | 4. Install our Server Allocator For WHMCS module and configure it properly. | ||
: It must assign a server to a product depending on the selected option in '' 'Location' '' configurable option.<br/> | : It must assign a server to a product depending on the selected option in '' 'Location' '' configurable option.<br/> | ||
Line 1,103: | Line 1,120: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 15px;"|Now, a client may order a VPS and select '' 'Location'.'' Server Allocator For WHMCS will change the server assigned to the product. <br/> | |style="padding: 0px 0px 30px 15px;"|Now, a client may order a VPS and select '' 'Location'.'' Server Allocator For WHMCS will change the server assigned to the product. <br/> | ||
− | Create action is triggered on the assigned server due to '' 'Server-Node' '' option enabled. | + | Create action is triggered on the assigned server due to the '' 'Server-Node' '' option enabled. |
|} | |} | ||
Line 1,113: | Line 1,130: | ||
|style="padding: 0px 0px 15px 15px;"|2. Multiple '''physical Proxmox servers''' can be joined into one cluster.<br /> | |style="padding: 0px 0px 15px 15px;"|2. Multiple '''physical Proxmox servers''' can be joined into one cluster.<br /> | ||
When they are joined into one '''cluster''', you can access all of them by connecting to any.<br /> | When they are joined into one '''cluster''', you can access all of them by connecting to any.<br /> | ||
− | + | *'''auto-node''' - Creates a new VM on the server (node) with the most free resources, so the administrator cannot control it.<br /> | |
+ | *'''server-node''' - Creates a VM on the server node which IP address or node host (e.g. node1.yourproxmox.com) was provided during the WHMCS's server configuration,<br />respectively the administrator is allowed to control the node choice. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|3. If you | + | |style="padding: 0px 0px 20px 15px;"|3. If you set the product type as '' 'Hosting Account' '' when adding a new product, you will not have to fill out namenservers, they will be automatically set up. |
|} | |} | ||
{| | {| | ||
Line 1,140: | Line 1,158: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|9. If you currently | + | |style="padding: 0px 0px 30px 15px;"|9. If you are currently using the module in the 2.3.2 version or previous, and would like to migrate to '''Proxmox VE V5.X''', you need to update the files on your Proxmox server to the new version from the ''' 'UploadOnProxmoxServer' ''' folder. |
|} | |} | ||
Line 1,155: | Line 1,173: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|2. Error 'Could not create PVE2_API object' during connecting via noVNC console.<br /> | + | |style="padding: 0px 0px 5px 15px;"|2. Error 'Could not create PVE2_API object' during connecting via the noVNC console.<br /> |
− | '''Reason:''' User account does not have permission to access noVNC console.<br /> | + | '''Reason:''' User account does not have permission to access the noVNC console.<br /> |
− | '''Solution:''' Proceed to product's 'Module Settings' tab and check whether selected user permission | + | '''Solution:''' Proceed to the product's 'Module Settings' tab and check whether selected a user permission grants access for the noVNC console.<br /> |
− | + | Afterward, proceed to the client's hosting and run '' 'Change User Role' '' on it.<br/> | |
− | To change user role for all clients please use '' 'Cron job users synchronization (run only once)' '' cron command.<br/> You will find it in the '' 'Proxmox Addon' → 'General Settings'.'' | + | To change user role for all clients please use the '' 'Cron job users synchronization (run only once)' '' cron command.<br/> You will find it in the '' 'Proxmox Addon' → 'General Settings'.'' |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|3. Error 'This connection is untrusted' during connecting via noVNC console.<br /> | + | |style="padding: 0px 0px 5px 15px;"|3. Error 'This connection is untrusted' during connecting via the noVNC console.<br /> |
'''Reason:''' Your certificate is not valid.<br /> | '''Reason:''' Your certificate is not valid.<br /> | ||
− | '''Quick Solution:''' Your client needs to add Proxmox address to certificate exception list.<br /> | + | '''Quick Solution:''' Your client needs to add the Proxmox address to the certificate exception list.<br /> |
− | '''Best Solution:''' Configure valid certificate. | + | '''Best Solution:''' Configure a valid certificate. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|4. Blank page during connecting via noVNC console.<br /> | + | |style="padding: 0px 0px 5px 15px;"|4. Blank page during connecting via the noVNC console.<br /> |
'''Reason:''' You have not uploaded 'mgnovnc.html' on to the Proxmox server.<br /> | '''Reason:''' You have not uploaded 'mgnovnc.html' on to the Proxmox server.<br /> | ||
− | '''Solution:''' Extract the module and upload 'mgnovnc.html' file located in 'UploadOnProxmoxServer' on all Proxmox servers into '/usr/share/novnc-pve/' folder. | + | '''Solution:''' Extract the module and upload 'mgnovnc.html' file located in 'UploadOnProxmoxServer' on all Proxmox servers into the '/usr/share/novnc-pve/' folder. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 5px 15px;"|5. Error 'Change password failed: user 'xxx' does not exist'<br/> | |style="padding: 0px 0px 5px 15px;"|5. Error 'Change password failed: user 'xxx' does not exist'<br/> | ||
'''Reason:''' You have not created a client yet.<br /> | '''Reason:''' You have not created a client yet.<br /> | ||
− | '''Solution:''' When PAM authentication is used it is necessary to create a client first in order to change the password correctly. Read more about it [https://pve.proxmox.com/wiki/User_Management#pveum_authentication_realms here]. | + | '''Solution:''' When PAM authentication is used, it is necessary to create a client first in order to change the password correctly. Read more about it [https://pve.proxmox.com/wiki/User_Management#pveum_authentication_realms here]. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 5px 15px;"|6. Error 'Function "ssh2_connect" does not exist. Please Install SSH2 PECL before you start using the script.'<br/> | |style="padding: 0px 0px 5px 15px;"|6. Error 'Function "ssh2_connect" does not exist. Please Install SSH2 PECL before you start using the script.'<br/> | ||
− | '''Reason:''' You have not updated php.ini file<br /> | + | '''Reason:''' You have not updated the php.ini file<br /> |
'''Solution:''' After SSH2 PECL installation be sure that you have updated php.ini files for CLI and webserver. | '''Solution:''' After SSH2 PECL installation be sure that you have updated php.ini files for CLI and webserver. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|7. | + | |style="padding: 0px 0px 5px 15px;"|7. Once you have updated your Proxmox VPS For WHMCS to Proxmox VPS For WHMCS V2.0.0, it is always required to save your product configuration<br/> in module settings again. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|8. The current disk usage for the KVM virtualization type is not properly displayed.<br/>This is due to API limitations which currently | + | |style="padding: 0px 0px 15px 15px;"|8. The current disk usage for the KVM virtualization type is not properly displayed.<br/>This is due to API limitations which currently do not return the correct value, which is always set to '' '0' ''. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|9. Proxmox VPS For WHMCS does not provide direct support for HA clusters. | + | |style="padding: 0px 0px 30px 15px;"|9. Proxmox VPS For WHMCS does not provide a direct support for HA clusters. |
|} | |} |
Revision as of 15:34, 11 January 2018
Contents
|
About Proxmox VPS For WHMCS
Proxmox VPS For WHMCS is a powerful module which allows you to automatically provision virtual servers to your clients. With its help, your customers can manage virtual servers, backups, firewall as well as access VNC/SPICE console and much more - all this directly in your WHMCS client area. |
- Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server |
✔ Create/Terminate User Account |
✔ Change Package - Supports Configurable Options |
✔ Boot/Reboot/Stop/Shutdown Server |
✔ Change User Role |
✔ Access noVNC And SPICE Console |
✔ Migrate Server Between Nodes |
✔ Reinstall Server |
✔ View Server Status, Details And Statistics |
✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs |
✔ Display Disk And Bandwidth Usage Of Each Product |
✔ Display CPU And Memory Usage Of Each Product |
✔ Auto Node - Possibility To Automatically Create VM On Node With The Most Free Space |
✔ Configure Client Area Features Per Product |
✔ Import IP Address To Hosting IP Addresses Table |
✔ Return IP Address To IP Addresses Subnet |
✔ Add Additional IP Address To VM |
✔ Add Additional Storage To VM (KVM) |
✔ Enable Backups Routing |
✔ Enable Auto VM Backups Before Reinstall |
- Proxmox Addon Features:
✔ Display Servers List Per VPS And Cloud |
✔ Manage IP Addresses Per Server, VLAN, Tag And Node |
✔ Add Additional DHCP Server |
✔ Display Servers Clusters |
✔ Display KVM Templates |
✔ Convert KVM VPS To KVM Template |
✔ Set Minimum VM ID For Product Without ID Ranges Defined |
✔ Synchronize Users Permissions |
✔ VM Cleaner - Manage VM Not Existing In Your WHMCS |
✔ Create And Store Full Backup Of VMs Configuration |
✔ Manage SSH Key Pairs For KVM Template |
✔ View Tasks History |
- Client Area Features:
✔ Boot/Reboot/Stop/Shutdown/Reinstall Server |
✔ Access noVNC And SPICE Console |
✔ Create/Restore/Delete Backups |
✔ Manage Backups Within Defined Limits (Max Number Of Files & Max Size Of Files) |
✔ Manage Backup Jobs Within Defined Limits (Max Number Of Files & Max Size Of Files) |
✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs |
✔ View Task History |
✔ View Network Devices And Manage Private Interface |
✔ Create Server Snapshot (KVM) |
✔ Manage Firewall |
✔ Download Public And Private SSH Keys (LXC) |
✔ View Server Status, Details And Statistics |
✔ Display Disk And Bandwidth Usage |
✔ Display CPU And Memory Usage |
✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely |
- Configurable Options:
✔ KVM: |
✔ Number of CPU Sockets |
✔ Number of Cores Per Socket |
✔ CPU Weight For VM |
✔ Amount of RAM |
✔ Disk Space |
✔ Network Rate |
✔ IPv4 Addresses |
✔ IPv6 Addresses |
✔ Backups Limit |
✔ Backups Files Limit |
✔ Bandwidth Limit |
✔ VM Template |
✔ ISO Image |
✔ LXC: |
✔ 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 |
- General Info:
✔ Supports PVE And PAM Authentication |
✔ Supports KVM and LXC Virtualization |
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more) |
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Subnets (read more) |
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more) |
✔ Multi-Language Support |
✔ Supports Proxmox VE Up To V5.X |
✔ Supports IPv4 and IPv6 |
✔ Supports PHP 5.4 Up To PHP 7 |
✔ Supports WHMCS Templates Five and Six |
✔ Supports WHMCS V6 and V7 |
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 the module. |
2. In the downloaded file you will find two packages that support different PHP versions. As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6. It does not apply to open source versions. Note: You can check the current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'. |
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory. The content of PHP version files should look like this. |
4. Open 'UploadOnProxmoxServer' and upload content of proper version on all Proxmox servers into the '/usr/share/novnc-pve/' folder. Note: If you wish to allow noVNC consoles, you need to configure a product using the PVE realm and set user permissions to 'PVEVMUser.' |
5. When you install Proxmox VPS For WHMCS for the first time you have to rename the 'license_RENAME.php' file. File is located in 'modules/servers/proxmoxVPS/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
6. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. |
Activation of Proxmox Addon
7. Firstly, activate Proxmox Addon. To do so, log in to your WHMCS and press 'Setup' → 'Addon Modules'. Find 'Proxmox Addon' and press 'Activate'. |
8. In the next step you need to permit access to this module. To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'. |
Configuration of Server
9. Now, we will show you how to configure a new product. Go to 'Setup' → 'Products/Services' → 'Servers' and press the 'Add New Server' button. |
10. Next, enter your server name, IP address, username and password. Choose an authentication type from 'Authentication' and 'Proxmox VPS' from 'Type' dropdown menus. 'Save Changes'. |
11. After configuring your server correctly, you will see the following screen. In order to check connection to a Proxmox server, simply press 'Test Connection' as shown on the screen below. |
12. It is time to create a server group, to do so click on 'Create Server Group'. |
13. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'. |
Configuration of Product
14. In order to create and configure a product go to 'Setup' → 'Products/Services' → 'Products/Services'. Click on 'Create a New Group'. |
15. Enter a product group name and press 'Save Changes'. |
16. When you have a product group, you can assign your product to it. To create a product click on 'Create a New Product'. |
17. Afterward, choose your product group and its type from dropdown menus, enter your product name and press 'Continue'. 'Product Type' can be set to 'Dedicated/VPS Server' but nameservers will have to be added later. |
18. Now go to the 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus. Next, 'Save Changes'. |
19. From dropdown menus choose 'Virtualization Type', 'Default Node' and 'Template & ISO Storage'. Available virtualization types: |
20. Setting the KVM virtualization type (skip, if you have chosen the LXC virtualization type). From dropdown menus choose 'KVM OS Type' and 'Default Storage'. |
21. Now, select desired values from 'Storage', 'Disk Type', 'CD/DVD-ROM Type', 'ISO Image', 'Network Mode' and 'Network Model'. Additionally, set up backups in the 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus. |
22. Setting the LXC virtualization type (skip, if you have chosen the KVM virtualization type). From dropdown menus choose 'Default Storage' , 'Template' and 'Bridge'. |
23. Setting the OpenVZ virtualization type (skip, if you have chosen the KVM virtualization type). Please note that only versions of Proxmox prior to v.2.3.0 support OpenVZ virtualization. From dropdown menus choose 'Default Storage' and 'OpenVZ OS Template'. |
24.Afterward, press 'Generate default' nearby 'Configurable Options' and 'Custom Fields'. |
By doing so, you have just added required custom fields and optional configurable options listed in this table. Note that while generating 'Configurable Options' it is advisable to delete the ones you no longer use, e.g. for the KVM virtualization delete swap option or IPv6. |
25. At the end of the product configuration you have to add a cron job as 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. The cron can be also run each minute in order to perform the action more often. |
Congratulations! You have just finished the installation and configuration of the module. |
Configuration of Addon
26. Proceed to 'Addons' → 'Proxmox Addon' → 'Settings' → 'General Settings' and set up cron jobs listed under the 'Cron' section. |
27. Adding a new IP address (if you are not using IP Manager For WHMCS). In order to create a new product you have to add 'Dedicated IP ' to the 'IP Addresses' list in 'Proxmox' addon module. |
28. Start by typing a desired IP address and mask into 'IP Pool'. Next, choose a server from the 'Server' dropdown menu and define which virtualization it should be applied to through selecting it from the 'Virtualization' dropdown menu. |
29. You are now able to create a new product using the previously added IP address. If you are using the KVM virtualization type, the client area in a successfully created product should look similar to the one on the screen below. |
30.The client area with the LXC virtualization type product looks quite similar. |
Configuration of SSH Keys (KVM)
SSH keys are required to enable the automatic resizing of partition upon the disk upgrade as well as the change of passwords for the KVM virtualization type. Note - 'Resize Partition' and 'Change Root Password' will only work for newly created VMs with ISC DHCP and Internet access configuration. We recommend using this option only for new products. |
31. First, create a new VM Template that you will use for the KVM image. Then, generate SSH keys and add the public key to the root account on the newly created VM image. Moreover, upload both ( public and private ) keys on your WHMCS server in a secure location. |
32. Next, while in your WHMCS, go to 'Proxmox Addon' → 'Settings' → 'SSH Keys' and press the 'Add' button. |
33. Enter a name and location to the key pairs located on your WHMCS server. |
34. Then, go back to the product configuration and in ' KVM Configuration' → 'VM SSH Root Key' select the pair of keys you want to use. Enter the SSH communication port and select features you want to use. Make sure they match the 'KVM OS Template' that will be used. |
35. Now, the 'Resize Partition' and 'Change Root Password' options should be available.
Note - if a customer decides to remove the public key from the VM on their own, it will render the 'Resize Partition' and 'Change Root Password' options no longer working!
|
The above mentioned features can be also executed in the client area using the options below. |
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. |
Afterward, enter IP address in a textbox and confirm through pressing 'Save Changes'. |
Management of Addon
Servers Management
Server List
In 'Addons' → 'Proxmox Addon' → 'Servers' → 'Servers List' you can find configured Proxmox servers. RAM details:
Suspended - number of suspended accounts per their size in MB |
Define ID range and save changes. |
Through pressing 'Edit' you will be moved to the server edit page. |
VMs List
In 'Addons' → 'Proxmox Addon' → 'Servers' → 'VMs List' you can find details of any proxmox product. |
Use the 'Toggle Filters' button to find entries you are the most interested in. |
Recovery VM Lists
In 'Addons' → 'Proxmox Addon' → 'Servers' → 'recovery VM List' you can find configured Proxmox servers. Run 'recovery cron job' to create and store full backups of VMs configuration. |
IP Management
At the 'IP Management' tab you can add, edit and remove IP addresses of Proxmox products. |
Automatic IP Address Assignment
Automatic IP address assignment can be applied to your Proxmox module, all you need to do is install 'DHCP' (Dynamic Host Configuration Protocol) and IP addresses will be automatically requested from a DHCP server. Consequently, the need to manually configure them will be reduced to a minimum. Important! This option is available only for the 'KVM' virtualization type. When there are no IP addresses assigned to the module, then it will create a VM without any IP address. In that case, you should verify the configuration of your IP Manager, after that you are allowed to run the 'Change Package' command in order to assign IP addresses. Read the below section to learn how to properly install and configure DHCP. |
1. First of all, you must install the SSH2 package on your WHMCS server. Find precise instructions on how to do that here.
|
2. Now, you may move to ISC DHCP installation and configuration. Follow the steps below:
sudo apt-get install isc-dhcp-server
sudo nano /etc/dhcp/dhcpd.conf
sudo nano /etc/dhcp/dhcpd6.conf Below there is an exemplary content of a properly created file: /etc/dhcp/dhcpd.conf. # Sample /etc/dhcpd.conf # (add your comments here) default-lease-time 600; max-lease-time 7200; option subnet-mask 255.255.255.0; option broadcast-address 192.168.1.255; option routers 192.168.1.254; option domain-name-servers 192.168.1.1, 192.168.1.2; option domain-name "mydomain.example"; subnet 192.168.1.0 netmask 255.255.255.0 { #ProxmoxIPv4 host 1 {hardware ethernet 32:62:39:64:33:33;fixed-address 1.1.1.101;} host 2 {hardware ethernet 32:39:61:31:33:66;fixed-address 1.1.1.243;} }
|
3. Turn on ISC DHCP.
To use the automatic IP addresses assignment feature, select 'ISC DHCP Server' option in 'Module Settings' under the 'KVM Configuration' section. |
IP Manager Integration
Owing to integration with IP Manager For WHMCS you are able to easily create subnets with IP addresses and assign them to desired products. By activating the IP Manager submodule, settings concerning IP adresses such as 'Configurable Options' and 'Default Options' are ignored by Proxmox VPS. |
3. Afterward, create a new configuration and assign the previously created subnet to it. Note: Multiple IP addresses subnets can be assigned to a single configuration. |
5. Now, enable the integration by proceeding to the '3rd Party Integration' tab. Press 'Activate' next to the 'proxmoxVPS' module type as shown on the following screen. |
6. Next, assign the previously created configuration to the submodule. Press 'Configure' , choose a configuration and press 'Save Changes'. |
In case you encounter an error like on the below screen while integrating the two products, probably the function 'mb_strlen' is not enabled by default. Please read the manual here for installation instructions. |
Clusters
The 'Clusters' tab contains the list of clusters. To view information about a cluster simply press its name. |
Here you can find various information about a cluster, from available resource to usage graphs. |
Templates List
Under this page you can view the list of templates. You may also delete unused templates here. |
Create Templates
You can easily convert any VM on your server to a template. In order to convert a VM, go to 'Proxmox Addon' → 'Templates' → 'Create Template'. |
Next, choose a node and VM to convert. Fill out 'Template Friendly Name' and press 'Save Changes'. |
General Settings
'Minimum VMID' allows you to define a minimal ID of a VM created on the server, which does not have any VMID range defined. Cron job user synchronization - if you change a user role in the product settings, this cron job changes the roles of existing users. |
VM Cleaner
VM Cleaner allows you to track VMs existing only on your Proxmox server and that are not visible in your WHMCS. Consequently, you are allowed to sort and delete only those VMs that cannot be managed from your WHMCS. |
SSH Keys
SSH Keys section allows you to manage your SSH key pairs that will be used for your KVM virtualization. These keys will be next used to enable the automatic resizing of a partition upon the disk upgrade as well as the change of a root password on the VM. |
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 a VM. |
On the main product page in the client area, under the 'Details' headline your clients can find information about current usage of CPU, memory, disk (LXC only) and SWAP (LXC only). Customers can also view 'DNS' (LXC only) and 'IP Addresses'. |
Client Area - VM Management
VNC Console
VNC console 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. |
noVNC Console
noVNC console allows your clients to connect to their server in the easiest possible way. |
SPICE Console
SPICE console enables you to connect to virtual machine using SPICE. Note: Your client needs to download and install client side SPICE application in order to connect with a VM. |
Client Area - Additional Tools
Reinstall
Reinstall feature should be used to change templates. Select template from available templates list to reinstall your server, click the 'Reinstall' button. |
Backups
To create a single backup, press the 'Backups' button and click on 'New Backup' as shown on the following screen. |
Now, choose 'Compress Dump File' and 'Backup Mode' from dropdown menus. Afterward, press 'Add'. |
To restore a VM from backup, press 'Restore' and then click the 'OK' button in a popup window to confirm. |
Backup Jobs
By pressing 'Backup Jobs' in your client area, you will be carried to the backup jobs management page. There you can easily edit/delete and preview details of existing backup jobs. |
Now, define a backup time, mark days to run it and choose 'Compression Dump File' and 'Backup Mode' from dropdown menus. Next, press the 'Add' button. |
Graphs
Through pressing the 'Graphs' button clients will be moved to the page with generated graphs 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 on the following screen. Choose from 'Hour', 'Day', 'Week', 'Moth' and 'Year'. |
Task History
To access the history of a VM, simply press the 'Task History' button. |
Network
Your clients are allowed to add/remove only private network interface devices. Keep in mind that ' Network device' options must be set as 'Private'. |
Snapshots (KVM only)
Use a snapshot to remember a current state contents of the virtual machine memory. You may use them later to restore the VM's settings. |
Press the 'Take Snapshot' button and fill out the form to take a snapshot. Name it (use alphabetical characters only), choose whether to include RAM and add a description. |
Firewall
Owing to the 'Firewall' page, your clients can set up firewall rules and enable a security group for their servers from your WHMCS client area. As you can see, you can easily modify and remove previously added rules and security groups. |
You can add a firewall rule in two ways. Both of them require choosing a direction, action, interface, source and a destination. The first way (red) is by choosing macro from the 'Macro' dropdown field. |
Choose a security group and an interface on which the group will be used. Additionally, you can enable a security group and add a comment to it. |
Disks (KVM only)
View available disks and add new ones. |
Configurable Options
When you successfully set up a product, your client can order it by choosing from the default configurable options. |
In case those options do not suit your needs, you can edit them. Go to 'Setup' → 'Products/Services' → 'Configurable Option' and press the edit button next to the configurable option used by your product. |
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 a VPS with 4 cores per socket. |
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. |
List of Configurable Options
The table below lists all configurable options used by the module for the chosen virtualization type. |
KVM |
LXC |
---|---|
The number of CPU sockets|CPU Sockets |
cores|CPU Cores |
The number of cores per socket|CPU Cores |
cpulimit|Limit Of CPU |
cpulimit|Limit Of CPU |
CPU weight for a VM|CPU Weight For The VM |
CPU weight for a VM|CPU Weight For The VM |
Amount of RAM|Amount Of RAM |
Amount of RAM|Amount Of RAM |
Disk Space|Disk Space |
Disk Space|Disk Space |
Amount of SWAP|Amount Of SWAP |
additionalDisksSpace|Additional Disks Space |
IP Addresses|IPv4 Addresses |
IP Addresses|IPv4 Addresses |
IPv6 Addresses|IPv6 Addresses |
IPv6 Addresses|IPv6 Addresses |
Backups Limit|Backups Size |
Backups Limit|Backups Size |
Backups Files Limit|Backup Files |
Backups Files Limit|Backup Files |
Bandwidth|Bandwidth |
Bandwidth|Bandwidth |
VM Template|VM Template |
VM Template|VM Template |
Network Rate|Network Rate |
Network Rate|Network Rate |
|
vcpus|VCPUs | |
ISO Image|ISO Image |
|
osType|OS Type |
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. |
With Advanced Billing For WHMCS module, you can also display your customers current server resource usage and their cost. |
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. |
Servers Location Management
Important: Server Allocator For WHMCS is required to allow locations management. In order to allow defining locations for Proxmox VPS, follow the below steps:
Keep in mind that all locations must have exactly the same configuration. |
Now, a client may order a VPS and select 'Location'. Server Allocator For WHMCS will change the server assigned to the product. Create action is triggered on the assigned server due to the 'Server-Node' option enabled. |
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. |
2. Multiple physical Proxmox servers can be joined into one cluster. When they are joined into one cluster, you can access all of them by connecting to any.
|
3. If you set the product type as 'Hosting Account' when adding a new product, you will not have to fill out namenservers, they will be automatically set up. |
4. OS Templates are not automatically downloaded while configuring a product. For each virtualization type, templates are downloaded from the Proxmox server depending on which one of them they are generated for. |
5. OS Templates are loaded from the Storage. Make sure the module can access its content by selecting appropriate permissions for the chosen Storage. |
6. KVM virtualization supports only graphs concerning 'Bandwidth'. Other virtualizations support all graphs. This is due to API limitations. |
7. When PAM authentication is used it is necessary to create a client first in order to change the password correctly. Read more about it here. |
8. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process. |
9. If you are currently using the module in the 2.3.2 version or previous, and would like to migrate to Proxmox VE V5.X, you need to update the files on your Proxmox server to the new version from the 'UploadOnProxmoxServer' folder. |
Update Instructions
Essential guidance through the process of updating the module is offered here. Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price! |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. Error 'Could not create PVE2_API object' during connecting via the noVNC console. Reason: User account does not have permission to access the noVNC console. To change user role for all clients please use the 'Cron job users synchronization (run only once)' cron command. |
3. Error 'This connection is untrusted' during connecting via the noVNC console. Reason: Your certificate is not valid. |
4. Blank page during connecting via the noVNC console. Reason: You have not uploaded 'mgnovnc.html' on to the Proxmox server. |
5. Error 'Change password failed: user 'xxx' does not exist' Reason: You have not created a client yet. |
6. Error 'Function "ssh2_connect" does not exist. Please Install SSH2 PECL before you start using the script.' Reason: You have not updated the php.ini file |
7. Once you have updated your Proxmox VPS For WHMCS to Proxmox VPS For WHMCS V2.0.0, it is always required to save your product configuration in module settings again. |
8. The current disk usage for the KVM virtualization type is not properly displayed. This is due to API limitations which currently do not return the correct value, which is always set to '0' . |
9. Proxmox VPS For WHMCS does not provide a direct support for HA clusters. |