Proxmox VE VPS For WHMCS
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. Additionaly it allows you to conveniently manage your servers, IP addresses and clusters. |
- 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) |
| ✔ VNC Console Access |
- Proxmox Addon Features:
| ✔ Servers List |
| ✔ IP Management (Per Server) |
| ✔ Clusters (Per Server) |
- Client Area Features:
| ✔ Boot Server |
| ✔ Reboot Server |
| ✔ Stop Server |
| ✔ Shutdown Server |
| ✔ Reinstall Server |
| ✔ VNC Console |
| ✔ Create Backups |
| ✔ Restore Backups |
| ✔ Backup 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) |
| ✔ Easy Product Upgrade/Downgrade |
- Admin Area Features:
| ✔ 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 (coming soon) |
| ✔ Multi-Language Support |
| ✔ Supports Proxmox VE 3 and Later |
| ✔ 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 |
| ✔ IP Addresses |
| ✔ OpenVZ: |
| ✔ Number of CPU Sockets |
| ✔ Amount of SWAP |
| ✔ CPU Weight For a VM |
| ✔ Amount of RAM |
| ✔ Disk Space |
| ✔ IP Addresses |
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 '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 licence key between quotation marks as presented on the following screen. |
| 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 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' . |
| File:PX7.png |
| 8. Next, enter your server name, IP address, username and password. Choose 'Proxmox VPS' from a dropdown menu and press 'Save Changes' . |
| File:PX8.png |
| 9. After you configure your server correctly, you will see a following screen. You can check connection with Proxmox server, simply press 'Test Connection' as shown on 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 click on '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.png |
| 14. When you have a product group, you can create your product. To create a product click on 'Create a New Product' . |
| File:PX14.png |
| 15. Afterwards choose your product group and type from a 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 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from a dropdown menus. Next, click on 'Save Changes' . |
| File:PX16.png |
| 17. From a dropdown menus choose 'Virtualization Type' , 'Default Node' and 'Template & ISO Storage' . Afterwards press 'Save Changes' . |
| File:PX17.png |
| 18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type) From a dropdown menus choose 'KVM OS Type' , 'Storage' , 'Disk Type' , 'CD/DVD-ROM Type' , 'ISO Image' , 'Network Mode' , 'Network Model' , 'Bridge' , 'Node' and 'Storage' . |
| File:PX18.png |
| 19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type) From a dropdown menus choose 'OpenVZ OS Template' , 'Target Storage' , 'Node' and 'Storage' . |
| File:PX19.png |
| 20. At the end of configurating product press 'Generate default' texts near 'Configurable Option' and 'Custom Fields' . |
| File:PX19 1.png |
Configuration of Addon
| 20. Adding new IP address In order to create new product you have to add product 'Dedicated IP ' to 'IP Addresses' list in 'Proxmox' addon module. |
| File:PX20.png |
| 21. Type desired IP in 'IP Pool' and choose server from a 'Server' dropdown menu. Afterwards press 'Add Pool' . |
| File:PX21.png |
| 22. 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 producs should look simillar as on the screen below. |
| File:PX22.png |
| 23.The Client area of product using OpenVZ virtualization type look 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. |
| File:PX23 5.png |
Management of Addon
| In 'Addons' → 'Proxmox Addon' → 'Server List' you can find servers you have configured. To see what product are created and assigned to your Proxmox server simply click on it's '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, VM ID or VM Type. |
| File:PX25.png |
| In 'IP Management' tab you can add, edit and remove IP of Proxmox products. |
| File:PX26.png |
| 'Clusters' tab contains clusters list. To view information about cluster simply press on it's 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 cluster list, press on 'Back to clusters list' button. |
| File:PX26 3.png |
Interface
| Client area interface for 'Proxmox VPS' 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. |
| File:PX27.png |
VNC Console
| 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. Console require 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 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 from a dropdown menus 'Compression Dump File' and 'Backup Mode' . 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' button as shown on the folowing screen. |
| File:PX31 2.png |
| Now choose 'Compress Dump File' and 'Backup Mode' from a dropdown menus. Afterward press 'Add Backup' . |
| File:PX31 3.png |
| To restore VM from backup simply press 'Restore' and press 'OK' button in a popup window to confirm. |
| File:PX31 4.png |
| In main product page in the client area, under 'Details' headline your client can find information about current usage of CUP, memory and disk (OpenVZ only). Customer can also view 'DNS' (OpenVZ only) and 'IP Adresses' . |
| File:PX32.png |
Graphs
| Under 'Details' section client can find graph of CPU and memory usage, network traffic and disc I/O. He can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen. |
| File:PX33.png |
Management of Configurable Options
| When you successfully setup product your client can order it choosing from default configurable options. |
| File:PX33 1.png |
| But in case they 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( it name is 'Configurable options for your_product_name' ). |
| File:PX33 2.png |
| Here you can view all product this configurable option group is assigned to. Now let us show you how to edit options, let say you want to add option to order VPS with 4 cores per socket. |
| File:PX33 3.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 module, you can also display your customers the current server resource usage and their cost. |
| File:PX35.png |
Update of Products
| Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings. Firstly, go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedVPS' . |
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. |