|
|
| (973 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| − | <meta name="keywords" content="proxmox vps for whmcs, proxmox vps configuration, whmcs proxmox vps management, whmcs proxmox vps installation, whmcs proxmox vps common problems, about whmcs proxmox vps, whmcs proxmox vps documentation, whmcs proxmox vps faq, whmcs proxmox vps help, whmcs proxmox vps guide, whmcs proxmox vps wiki, whmcs proxmox vps tutorial, whmcs proxmox vps tips, whmcs proxmox vps wiki"></meta> | + | <meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
| − | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Proxmox VPS For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| − | =About [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS For WHMCS]= | + | |
| | + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 0px;"|'''Proxmox VPS For WHMCS''' is a powerful module which allows you to automatically provision virtual servers to your clients.<br /> | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
| − | 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.<br />
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br /> |
| − | Additionally, the module lets you conveniently manage all existing servers, IP addresses and clusters through the unique Proxmox Addon attached to the module.<br />
| + | You can also define email templates and view details of each sent notification owing to logs. |
| | |} | | |} |
| − | <!-- comment can fix everything --> | + | <!--a comment maybe? --> |
| | *'''Admin Area Features:''' | | *'''Admin Area Features:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate User Account | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Change User Role | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Server | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Change Package - Supports Configurable Options | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Stop Server | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Server Status, Details And Statistics | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display Disk And Bandwidth Usage Of Each Product
| + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display CPU And Memory Usage Of Each Product
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Access VNC/SPICE/noVNC Console
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Migrate Server Between Nodes
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Auto Node - Possibility To Automatically Create VM On Node With The Most Free Space
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Import IP Address To Hosting IP Addresses Table
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Return IP Address To IP Addresses Pool
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Add Additional IP Address To VM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Enable Backups Routing | + | |
| − | |}
| + | |
| − | *'''Proxmox Addon Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Display Servers List Per VPS And Cloud
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage IP Addresses Per Server
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display Servers Clusters
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display KVM Templates
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Convert KVM VPS To KVM Template
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Set Minimum VM ID For Product Without ID Ranges Defined
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Synchronize Users Permissions
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ VM Cleaner - Manage VM Not Existing In Your WHMCS
| + | |
| − | |}
| + | |
| − | *'''Client Area Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Boot/Reboot/Stop Server
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Shutdown Server
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Access VNC/SPICE/noVNC Console
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Create/Restore Backups
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Backup Jobs
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Backups Within Defined Limits (Max Number Of Files & Max Size Of Files)
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Scheduled Backups Within Defined Limits (Max Number Of Files & Max Size Of Files)
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Task History
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Network Devices
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Create Server Snapshot
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Firewall
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Server Status, Details And Statistics
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display Disk And Bandwidth Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display CPU And Memory Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Easy Product Upgrade/Downgrade
| + | |
| | |} | | |} |
| | *'''General Info:''' | | *'''General Info:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Supports PVE And PAM Authentication | + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Server Resources Chosen During Order | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Ability To Upgrade Server Resources | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
| | |} | | |} |
| | + | |
| | + | =Installation= |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
| + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br /> |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Complete Management of IP Pools [http://www.modulesgarden.com/products/whmcs/ip_manager/features (read more)]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports Proxmox VE 3.4 and Earlier (V4.0 Coming Soon)
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports IPv4 and IPv6
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V5 and V6
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Requires PHP 5.3 and Later
| + | |
| − | |}
| + | |
| − | *'''Available Configurable Options:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ '''KVM''':
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Number of CPU Sockets
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Number of Cores Per Socket
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ CPU Weight For VM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Amount of RAM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Disk Space
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Network Rate
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ IPv4 Addresses
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ IPv6 Addresses
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Backups Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Backups Files Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ VM Template
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 45px;"|✔ ISO Image
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 5px 0px 0px 30px;"|✔ '''OpenVZ''':
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ The Number of CPU Sockets
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Amount of SWAP
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ CPU Weight For a VM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Amount of RAM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Disk Space
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ IPv4 Addresses
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ IPv6 Addresses
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Backups Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Backups Files Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Limit
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 45px;"|✔ VM Templates
| + | |
| − | |}
| + | |
| − | =Installation and Configuration=
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Proxmox VPS For WHMCS.''' <br /> | + | |
| | We will guide you step by step through the whole installation and configuration process. | | We will guide you step by step through the whole installation and configuration process. |
| | |} | | |} |
| | ==Installation== | | ==Installation== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Proxmox VPS For WHMCS.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''2. Extract the module, open '' 'UploadOnProxmoxServer' '' and upload content of proper version on all Proxmox servers into '' '/usr/share/novnc-pve/' '' folder.'''<br /> | + | |style="padding: 0px 0px 10px 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 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> |
| − | ''Note: If you wish to allow noVNC consoles, you need to configure product using PVE realm and set user permissions to 'PVEVMUser '.'' | + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|'''3. Upload and extract the module into the main WHMCS directory.''' | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_2.png]] | + | |style="padding: 0px 0px 15px 15px;"|'''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.'''<br /> |
| | + | The content of PHP version files should look like this. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Proxmox VPS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]] |
| − | File is located in '' 'modules/servers/proxmoxVPS/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_3.png]] | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| | + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br /> | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| − | Enter your license key between quotation marks as presented on the following screen.<br />
| + | |
| − | You can find your license key in your client area → '' 'My Products'. ''
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_4.png]] | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br /> |
| | + | Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''. |
| | |} | | |} |
| − |
| |
| − | ==Activation of Proxmox Addon==
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|'''6. Firstly, activate Proxmox Addon.''' <br />
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| − | To do so, log in into your WHMCS and press '' 'Setup' '' → '' 'Addon Modules'. '' Find '' 'Proxmox Addon' '' and press '' 'Activate'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_5.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''7. 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'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_6.png]] | + | |
| − | |}
| + | |
| − | | + | |
| − | ==Configuration of Server==
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|'''8. Now, we will show you how to configure a new product.''' <br />
| + | |
| − | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_7.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''9. 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'. '''''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_8.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''10. After configuring your server correctly, you will see a following screen.''' <br />
| + | |
| − | In order to check connection with a Proxmox server, simply press '' 'Test Connection' '' as shown on the screen below.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_9.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''11. It is time to create a server group, to do so click on '' 'Create Server Group'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_10.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''12. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes'. '''''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_11.png]]
| + | |
| − | |}
| + | |
| − | | + | |
| − | ==Configuration of Product==
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure a product go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
| + | |
| − | Click on '' 'Create a New Group'.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_12.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''14. Enter product group name and press '' 'Save Changes'. '''''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_13.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can assign your product to it.'''<br />
| + | |
| − | To create a product click on '' 'Create a New Product'.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_14.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''16. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue'. '''''<br />
| + | |
| − | '' 'Product Type' '' should be set to '' 'Dedicated/VPS Server' '' in order to add nameservers later.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_15.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''17. Now go to '' 'Module Settings' '' section, choose both '' 'Proxmox VPS' '' and your previously created server group from dropdown menus.<br />
| + | |
| − | Next, '' 'Save Changes'. '''''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_16.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''18. From dropdown menus choose '' 'Virtualization Type', '' '' 'Default Node' '' and '' 'Template & ISO Storage'. '''''<br />
| + | |
| − | Available virtualization types:<br/>
| + | |
| − | '''KVM'''<br/>
| + | |
| − | '''LXC''' ''(supported by proxmox 4.0 and later)''<br/>
| + | |
| − | '''OpenVZ''' ''(supported by proxmox version 3.4 and earlier)''<br/>
| + | |
| − | You can also choose how often bandwidth usage should be counted.<br />
| + | |
| − | Afterwards, press '' 'Save Changes'.''<br />
| + | |
| − | ''Note: If you choose 'Auto-Node' as a 'Default Note', new virtual servers will be created on the least used node.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_17.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''19. Setting KVM virtualization type (skip, if you have chosen OpenVZ virtualization type).'''<br />
| + | |
| − | From dropdown menus choose '' 'KVM OS Type' '' and '' 'Default Storage'.''<br />
| + | |
| − | Type your VM description in '' 'Container Description' '' and scroll down.<br />
| + | |
| − | You can also define VM prefix by filling in '' 'Default KVM Container Prefix' '' field.<br/>
| + | |
| − | Set '' 'USe Client name For VPS' '' to '' 'Yes' '' and either the client's comapny or their first/last name will be used as the hostname value.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_18.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''20. 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 />
| + | |
| − | 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 />
| + | |
| − | In '' 'Firewall Options' '' section you can set up available interfaces and firewall rules limit.<br />
| + | |
| − | '''Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.'''<br />
| + | |
| − | '''There is no possibility to set your own password due to Proxmox API limitations to KVM virtualization.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_19.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''21. Setting of OpenVZ virtualization type (skip, if you have chosen KVM virtualization type).'''<br />
| + | |
| − | From dropdown menus choose '' 'Default Storage' '' and '' 'OpenVZ OS Template'. ''<br />
| + | |
| − | Additionally, define backup settings at '' 'Backups' '' section through selecting values from '' '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 />
| + | |
| − | Fill in 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'.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_20.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''22.Afterwards, press '' 'Generate default' '' nearby '' 'Configurable Options' '' and '' 'Custom Fields'. '''''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_21.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|By doing so, you have just added required custom fields and optional configurable options listed in the table below.
| + | |
| − | |}
| + | |
| − | {| class="wikitable"
| + | |
| − | ! style="width:400px; text-align:center;" | KVM<br />
| + | |
| − | ! style="width:400px; text-align:center;" | Open VZ<br />
| + | |
| − | |-<br />
| + | |
| − | | The number of CPU sockets|The number of CPU sockets<br />
| + | |
| − | | The number of CPU sockets|The number of CPU sockets<br />
| + | |
| − | |-<br />
| + | |
| − | | The number of cores per socket|The number of cores per socket<br />
| + | |
| − | | Amount of SWAP|Amount of SWAP<br />
| + | |
| − | |-<br />
| + | |
| − | | CPU weight for a VM|CPU weight for a VM <br />
| + | |
| − | | CPU weight for a VM|CPU weight for a VM<br />
| + | |
| − | |-<br />
| + | |
| − | | Amount of RAM|Amount of RAM<br />
| + | |
| − | | Amount of RAM|Amount of RAM<br />
| + | |
| − | |-<br />
| + | |
| − | | Disk Space|Disk Space<br />
| + | |
| − | | Disk Space|Disk Space<br />
| + | |
| − | |-<br />
| + | |
| − | | Network Rate|Network Rate<br />
| + | |
| − | | IP Addresses|IPv4 Addresses<br />
| + | |
| − | |-<br />
| + | |
| − | | IP Addresses|IPv4 Addresses <br />
| + | |
| − | | IPv6 Addresses|IPv6 Addresses<br />
| + | |
| − | |-<br />
| + | |
| − | | IPv6 Addresses|IPv6 Addresses<br />
| + | |
| − | | Backups Limit|Backups Limit<br />
| + | |
| − | |-<br />
| + | |
| − | | Backups Limit|Backups Limit<br />
| + | |
| − | | Backups Files Limit|Backups Files Limit<br />
| + | |
| − | |-<br />
| + | |
| − | | Backups Files Limit|Backups Files Limit <br />
| + | |
| − | | Bandwidth Limit|Bandwidth Limit<br />
| + | |
| − | |-<br />
| + | |
| − | | Bandwidth Limit|Bandwidth Limit<br />
| + | |
| − | | VM Template|VM Template<br />
| + | |
| − | |-<br />
| + | |
| − | | VM Template|VM Template<br />
| + | |
| − | | <br />
| + | |
| − | |-<br />
| + | |
| − | | ISO Image|ISO Image<br />
| + | |
| − | |
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''23. 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.phpyou may
| + | |
| − | Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|'''Congratulations! You have just finished the installation and configuration of the module.'''
| + | |
| | |} | | |} |
| | | | |
| | ==Configuration of Addon== | | ==Configuration of Addon== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'''24. Proceed to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Settings' '' → '' 'General Settings' '' and set up cron jobs listed under '' 'Cron' '' section. | + | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> |
| | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_21_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''25. 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;"|'''7. In the next step you need to permit access to this module.'''<br /> |
| − | In order to create a new product you have to add product '' 'Dedicated IP'' ' to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
| + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
| − | To do so, go to '' 'IP Management' '' and press '' 'Add Pool'. ''<br />
| + | |
| − | ''Note: You can add both IPv4 and IPv6 addresses.''
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_22.png]]
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''26. Start by typing desired IP address and mask into '' 'IP Pool'. '''''<br />
| + | |
| − | Next, choose a server from '' 'Server' '' dropdown menu and define which virtualization it should be applied to through selecting it from '' 'Virtualization' '' dropdown menu.<br />
| + | |
| − | Afterwards, press '' 'Add'. ''<br/><br />
| + | |
| − | ''Note! Automatic IP assignment works only for OpenVZ machines.''<br/><br />
| + | |
| − | ''KVM virtualization does not support IP Management from module. Instead, IP can be assigned via the console.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PXC2__23.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''27. You are now able to create a new product using the previously added IP address.'''<br />
| + | |
| − | If you use KVM virtualization type, the client area in a successfully created product should look similar to the one on the screen below.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_24.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''28.The client area with an OpenVZ virtualization type product looks quite similar.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_25.png]] | + | |
| | |} | | |} |
| | | | |
| − | =Management=
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
| − | You can monitor and manage each product from your WHMCS admin area. | + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
| | |} | | |} |
| − | ==Admin Area==
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|From the admin area you are able to view details and manage your client's VMs, access VMs consoles and even migrate VMs between nodes.<br />
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| − | You are also able to add an IP address to a product. To do so, press '' 'Add New IP' '' as shown on the following screen.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_26.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|Afterwards, enter IP address in a textbox and confirm through pressing '' 'Save Changes'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_27.png]] | + | |
| | |} | | |} |
| | | | |
| − | ==Management of Addon== | + | =Configuration and Management= |
| − | ===Server List===
| + | |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Servers' '' → '' 'Servers List' '' you can find configured Proxmox servers with their '''IP address,''' number of '''active accounts, status''' etc.<br /> | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| − | '''RAM''' details:
| + | |
| − | :Assigned - RAM assigned to the server (hosting services only)
| + | |
| − | :Total - full RAM on server
| + | |
| − | :Free - difference between Server Total RAM and RAM Assigned
| + | |
| − | '''Suspended''' - number of suspended accounts per their size in MB,<br/> ''i.e. (1/500 MB) when there is only one suspended account (size: 500MB of that account) assigned to Proxmox server VPS.''
| + | |
| − | You can quickly define VM ID ranges for those servers, press '' 'Manage' '' to do so.<br />
| + | |
| − | | + | |
| | |} | | |} |
| | + | ==Configuration== |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_28.png]] | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br /> |
| | + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| | + | Press '' 'Create New Group' '' to proceed. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|'''Importat:''' VM ID range allows you to sort VMs depending on the server they were created on. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
| − | Define '''VM Range''' and save changes.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_29.png]] | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| | + | You can choose between two types of resource usage counting:<br /> |
| | + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| | + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|Through pressing '' 'Edit' '' you will be moved to a server edition page. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_29_1.png]] | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| | + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| | + | Settings shown below result in sending notification to client upon: |
| | + | *bandwidth usage growth by 5GB during 21 days. |
| | + | *disk usage growth by 100GB over period of 14 days. |
| | |} | | |} |
| − |
| |
| − | ===IP Management===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|Under '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products. | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| | |} | | |} |
| | + | ==Logs== |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_30.png]] | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| | |} | | |} |
| − | ===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: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
| | |} | | |} |
| | + | ==Notifications== |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_31.png]] | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| | + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| | + | Additionally, you can use {if} statement, as shown below: |
| | + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| | + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| | + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|Here you can find various information about a cluster, from available resource to usage graphs.
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_32.png]]
| + | |
| − | |}
| + | |
| − | ===Templates List===
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 20px 15px;"|Under this page you can view the list of templates. You may also delete unused templates here.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_32_1.png]]
| + | |
| − | |}
| + | |
| − | ===Create Templates===
| + | |
| − | {|
| + | |
| − | |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 />
| + | |
| − | Choose server which VM to convert exists on and press '' 'Next Step'. ''<br />
| + | |
| − | '''Important: VM will be destroyed in the process.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_33.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|Next, choose node and VM to convert.<br />
| + | |
| − | Fill in '' 'Template Friendly Name' '' and press '' 'Save Changes'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_34.png]]
| + | |
| − | |}
| + | |
| − | ===General Settings===
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|'' 'Minimal VMID' '' allows you to define minimal ID of VM created from server, which does not have VMID range defined.<br />
| + | |
| − | Cron job user synchronization - if you change a user role in the product settings, this cron job changes the roles of existing users.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_35.png]]
| + | |
| − | |}
| + | |
| − | ===VM Cleaner===
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 20px 15px;"|VMVM Cleaner allows you to track VM existing only on your Proxmox server and that are not visible in your WHMCS.<br/> Consequently, you are allowed here to sort and delete only those VM that are not managed from your WHMCS.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_35_1.png]] | + | |
| | |} | | |} |
| | | | |
| − | ==Client Area== | + | =Tips= |
| | {| | | {| |
| − | |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 30px 15px;"| |
| − | As you can see, control panel contains options useful for managing VM.<br />
| + | |
| − | The module allows your customers to easily '' 'boot', 'reboot', 'stop' '' and '' 'shutdown' '' their servers through pressing a specific button.<br />
| + | |
| − | Clients can also access '' 'VNC', 'noVNC' '' and '' 'SPICE' '' consoles. Among '' 'Additional Tools' '' you will find options to '' 'reinstall' '' server, create '' 'backup' '' and set up '' 'backup jobs'.''<br />
| + | |
| − | Your clients are able to access resource usage '' 'graphs','' view VM '' 'history','' manage '' 'network' '' interface device and set up '' 'firewall' '' rules.<br/>
| + | |
| − | Additionally, in case of Proxmox VPS (KVM) clients may take '' 'snapshots' '' and manage '' 'disks'.''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_36.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|At the main product page in the client area, under '' 'Details' '' headline your clients can find information about current usage of CPU, memory, disk (OpenVZ only) and SWAP (OpenVZ only).<br/>
| + | |
| − | Customers can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses'. ''
| + | |
| | |} | | |} |
| | | | |
| − | ==Client Area - VM Management== | + | =Update Instructions= |
| − | ===VNC Console===
| + | |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|VNC console enables your clients to remotely manage their servers.<br /> | + | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
| − | To access it, simply press the '' 'VNC Console' '' button. Console requires Java software. You need to accept security risk to run it. | + | 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!<br/> |
| | + | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_39.png]]
| |
| − | |}
| |
| − | ===noVNC Console===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|noVNC console allows your clients to connect with their server in the easiest possible way.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_39_1.png]]
| |
| − | |}
| |
| − | ===SPICE Console===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|SPICE console enables you to connect with 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.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_40.png]]
| |
| − | |}
| |
| − | ==Client Area - Additional Tools==
| |
| − |
| |
| − | ===Reinstall (OpenVZ only)===
| |
| − | {|
| |
| − | |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 30px 25px;"|[[File:PX2_38.png]]
| |
| − | |}
| |
| − | ===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: 0px 0px 20px 25px;"|[[File:PX2_41.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Now, choose '' 'Compress Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
| |
| − | Afterwards, press '' 'Add'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_42.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 30px 25px;"|[[File:PX2_43.png]]
| |
| − | |}
| |
| − | ===Backup Jobs===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' '' in your client area, you will be carried to a backup jobs management page.<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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_44.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Now, define backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
| |
| − | Next, press '' 'Add' '' button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_45.png]]
| |
| − | |}
| |
| − | ===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 />
| |
| − | 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'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_46.png]]
| |
| − | |}
| |
| − | ===Task History===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|To access history of VM, simply press '' 'Task History' '' button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_47.png]]
| |
| − | |}
| |
| − | ===Network===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Your clients are able to easily create and remove network interface device.<br />
| |
| − | ''Note: You are allowed to remove only private network interface devices.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_48.png]]
| |
| − | |}
| |
| − | ===Snapshots (KVM only)===
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Use snapshot to remember the contents of virtual machine memory current state. You may use them later to restore the VM settings.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_48_4.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 some description.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_48_5.png]]
| |
| − | |}
| |
| − | ===Firewall===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Owing to '' 'Firewall' '' page, your clients can set up firewall rules and enable security group for theirs servers from your WHMCS client area.<br />
| |
| − | As you can see, you can easily modify and remove a 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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_48_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | The first way (red) is by choosing macro from a '' 'Macro' '' dropdown field.<br />
| |
| − | The second way (blue) consists of choosing protocol and filling source and destination ports out.<br />
| |
| − | Additionally, you can enable rule and add a comment to it.<br />
| |
| − | Press '' 'Add' '' to create a rule.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_48_2.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Insert a security group by choosing security group and interface on which the group will be used.<br />
| |
| − | Additionally, you can enable security group and add a comment to it.<br />
| |
| − | Click '' 'Add' '' to use the security group.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_48_3.png]]
| |
| − | |}
| |
| − | ===Disks (KVM only)===
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|View available disks and add new ones.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_48_6.png]]
| |
| − | |}
| |
| − |
| |
| − | ==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 pools of IP addresses and assign them to desired products.<br />
| |
| − | 1. Proceed to IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#IP_Pools IP Pools] tab in order to prepare IP addresses pool for Proxmox VPS For WHMCS.<br />
| |
| − | 2. Edit a previously created IP addresses pool and create custom field '' 'MAC Address' '' with desired MAC address at each IP address in the pool.<br />
| |
| − | More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Custom_Fields_For_IP_Addresses here].
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX_49.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|3. Afterwards, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign a previously created pool to it.<br />
| |
| − | ''Note: Multiple IP addresses pools 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 />
| |
| − | On the following screen we have linked them via configurable option assigned to Proxmox VPS product.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX_50.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|5. Now, enable integration by proceeding to '' '3rd Party Integration' '' tab.<br />
| |
| − | Press '' 'Activate' '' next to '' 'proxmoxVPS' '' module type as shown on the following screen.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX_51.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|6. Next, assign a previously created configuration to the submodule.<br />
| |
| − | Press '' 'Configure' '', choose the configuration and press '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX_52.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Configurable Options==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your client can order it by choosing from the default configurable options.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_53.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_54.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | To do so, edit '' 'The number of cores per socket' '' by pressing edit button as shown on the screen below.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX2_55.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You will see a popup window, so make sure your browser will not block it.<br />
| |
| − | To add a new option, enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.<br />
| |
| − | Finish through pressing '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX2_56.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Management of Billing==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|When you combine Proxmox VPS For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
| |
| − | Module allows you to charge your customers basing on the server resources used by them.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PX_57.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|With Advanced Billing For WHMCS module, you can also display your customers current server resource usage and their cost.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PX_58.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Management of Existing Accounts==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|'''You can easily use Proxmox VPS module with your existing Proxmox accounts. To do so, follow the instructions below:'''<br />
| |
| − | 1. Create and configure a Proxmox VPS server and a server group.<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 />
| |
| − | 4. Access the just created product from the admin area via client profile → '' 'Products/Services' '' section and fill in 4 custom fields.<br />
| |
| − | They are '' 'vmid' '', '' 'node' '', '' 'storage' '' and '' 'backup storage'. ''<br />
| |
| − | 5. If possible, enter IP addresses into fields '' 'Dedicated IP' '' and '' 'Assigned IPs' ''.<br />
| |
| − | 6. Set product status to '' 'Active' ''.<br />
| |
| − | '''Remember, do not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''
| |
| − | |}
| |
| − |
| |
| − | =Tips=
| |
| − | {|
| |
| − | |style="padding: 10px 0px 10px 15px;"|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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 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 />
| |
| − | While '''auto-node''' creates new VM on the server(node) with the most free resources, '''server-node''' creates VM on the server(node) which IP address it has (WHMCS's server configuration).
| |
| − | |}
| |
| − |
| |
| | =Common Problems= | | =Common Problems= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | + | |style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 5px 15px;"|2. Error 'Could not create PVE2_API object' during connecting via noVNC console.<br />
| + | |
| − | '''Reason:''' User account does not have permission to access noVNC console.<br />
| + | |
| − | '''Solution:''' Proceed to product's 'Module Settings' tab and check whether selected user permission grant right for noVNC console.<br />
| + | |
| − | Afterwards, proceed to client's hosting and run '' 'Change User Role' '' on it.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 5px 15px;"|3. Error 'This connection is untrusted' during connecting via noVNC console.<br />
| + | |
| − | '''Reason:''' Your certificate is not valid.<br />
| + | |
| − | '''Quick Solution:''' Your client needs to add Proxmox address to certificate exception list.<br />
| + | |
| − | '''Best Solution:''' Configure valid certificate.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|4. Blank page during connecting via noVNC console.<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.
| + | |
| | |} | | |} |
