SolusVM 2 VPS And Cloud For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
(→Activation of SolusVM 2 VPS & Cloud Addon) |
(→About SolusVM 2 VPS & Cloud For WHMCS) |
||
| (174 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
=About [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS] = | =About [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS] = | ||
{| | {| | ||
| − | |style="padding: 10px 0px 10px 0px;"|'''SolusVM 2 VPS & Cloud For WHMCS''' | + | |style="padding: 10px 0px 10px 0px;"|'''SolusVM 2 VPS & Cloud For WHMCS''' module offers provisioning of virtual machines as single VPS instances or flexible Cloud resources.<br/> |
| − | + | Allow your clients to create and manage servers within their limits using efficient tools for backups, snapshots, reinstallations, and real-time performance monitoring.<br/> | |
| + | Use the module to Empower your customers with comprehensive control over their virtual servers. | ||
|} | |} | ||
*'''Admin Area Features:''' | *'''Admin Area Features:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate | + | |style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Product |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Change Package |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Change | + | |style="padding: 0px 0px 0px 30px;"|✔ Change Password |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Import Virtual Machine (Cloud) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Existing Virtual Machines |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ From SolusVM 2.0 WHMCS Addon |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Available Resources (Cloud) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Pause/Unpause/Resume Servers |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Access noVNC Console |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rescue Mode |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ View | + | |style="padding: 0px 0px 0px 30px;"|✔ View Scheduled And Completed Tasks |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ View | + | |style="padding: 0px 0px 0px 30px;"|✔ View Queue |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Provide Product General Configuration: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Product Type: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ VPS - Provisioning Of Single Server Per Product |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Cloud - Enable Provisioning Of Multiple Servers Per Single Product |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Virtualization Type: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ KVM |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ VZ |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Image Format |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Compute Resource |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Default User Role |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Storage Type |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Server Location |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Server Limits: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Virtual CPUs |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ vCPU Units (VZ) |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 0px 45px;"|✔ vCPU Limit (VZ) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Disk Size [GiB] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Memory [MiB] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ IO Priority (VZ) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ SWAP [MiB] (VZ) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Additional IPv4 Addresses |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Additional IPv6 Addresses |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Default Server Configuration: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Enable IPv4 And IPv6 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Provide User Data Script |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Default Operating System / Application |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable Access To Client Area Features: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Backups |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Graphs |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Network |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Reinstall |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Snapshots |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Tasks |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Available Operation Systems |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Available Applications |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 0px 45px;"|✔ Select Server Information Entries |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 30px;"|✔ Generate Configurable Options |
|} | |} | ||
| + | *'''Addon Features:''' | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 0px 30px;"|✔ View Server Configurations Lists And Details: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ IP Address |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Active Accounts |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Status |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Customize Operation System And Application Logo Images |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Queue Of Scheduled Tasks And Details |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Customize Module Language Files With "Translations" Tool |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 30px;"|✔ View And Manage Logs |
|} | |} | ||
| + | *'''Client Area Features:''' | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 0px 30px;"|✔ Manage Single (VPS) Or Multiple (Cloud) Servers Per Product |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details |
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 0px 30px;"|✔ View Available Resources (Cloud) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Restart Servers |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Access noVNC Console |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rescue Mode |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Change Server Password |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Create/Manage/Restore Backups |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Server Graphs: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ CPU Usage |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Disk Throughput |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Network Throughput |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader | + | |style="padding: 0px 0px 0px 45px;"|✔ Memory Usage |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ View Network Details | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server Using: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Operating Systems | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Applications | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Create/Manage/Revert Snapshots | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ View Scheduled And Completed Tasks | ||
| + | |} | ||
| + | *'''Configurable Options:''' | ||
| + | {| | ||
| + | |style="padding: 10px 0px 0px 30px;"|✔ Virtual CPUs | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Limit of CPU [VZ] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ CPU Units for the VS | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Disk Size | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Amount of RAM | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Amount of SWAP [VZ] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ IO Priority [VZ] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Additional IPv4 Addresses | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Additional IPv6 Addresses | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ OS / Application | ||
| + | |} | ||
| + | *'''General Info:''' | ||
| + | {| | ||
| + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support With Custom Translations Tool | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 8.1 | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme" | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V8.9 | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V14 Or Later | ||
|} | |} | ||
{| | {| | ||
| Line 250: | Line 314: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/> | |style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/> | ||
| − | File is located in '' 'modules/servers/ | + | File is located in '' '/modules/servers/SolusVM2VpsCloud/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.'' |
|} | |} | ||
{| | {| | ||
| Line 260: | Line 324: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_3.png]] |
|} | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''6. In the next step, set up the 'storage' folder as recursively writable.<br/> | ||
| + | This folder is available at 'your_whmcs/modules/servers/SolusVM2VpsCloud/storage'. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_3_1.png]] | ||
| + | |} | ||
| + | |||
==Activation of SolusVM 2 VPS & Cloud Addon== | ==Activation of SolusVM 2 VPS & Cloud Addon== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''7. Firstly, activate the SolusVM 2 VPS & Cloud addon.''' <br /> |
| − | To do so, log in to your WHMCS and navigate to '' 'System Settings' | + | To do so, log in to your WHMCS and navigate to '' 'System Settings' →'Addon Modules'.'' Find '' 'SolusVM 2 VPS & Cloud' '' and press '' 'Activate'.''<br/> |
|} | |} | ||
{| | {| | ||
| Line 271: | Line 343: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |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 the '' '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 280: | Line 352: | ||
==Configuration of Server== | ==Configuration of Server== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''9. Now, log in to your WHMCS admin area and proceed to '' 'System Settings' → 'Servers'.'''''<br/> |
| − | + | Afterward, press '' 'Add New Server'.'' | |
|} | |} | ||
{| | {| | ||
| Line 287: | Line 359: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''10. Enter your server name and IP address.''' |
| − | + | * Set the '''Module''' to '' 'SolusVM 2 VPS & Cloud For WHMCS'.'' | |
| − | *'''Access Key | + | * Fill in the '''Secret Access Key''' with your SolusVM 2 API token. <br/> '''''Important:''' Make sure the token is created for a user with the 'Admin' role. Some functions of the module might not work properly otherwise.''<br/> |
| − | + | ||
| − | Check if your server uses SSL connection. <br/> | + | Check '''Secure''' option if your server uses an SSL connection.<br/> |
| − | + | You may test the connection by clicking on the dedicated button if successful, press '' 'Save Changes' '' to complete the server configuration. | |
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 299: | Line 370: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''11. Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.'' |
|} | |} | ||
{| | {| | ||
| Line 305: | Line 376: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''12. Fill in name, choose a previously created server and press '' 'Add'.'' '''<br/> |
Confirm by clicking on '' 'Save Changes'.'' | Confirm by clicking on '' 'Save Changes'.'' | ||
|} | |} | ||
| Line 314: | Line 385: | ||
==Configuration of Product== | ==Configuration of Product== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure product, go to '' 'System Settings' → 'Products/Services'.'''''<br/> |
Afterwards, click on '' 'Create a New Group'. '' | Afterwards, click on '' 'Create a New Group'. '' | ||
|} | |} | ||
| Line 321: | Line 392: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''14. Fill in a product group name and press '' 'Save Changes'.''''' |
|} | |} | ||
{| | {| | ||
| Line 327: | Line 398: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can create your product and assign it to SolusVM 2 VPS & Cloud.'''<br/> |
To create a product click on '' 'Create a New Product'.'' | To create a product click on '' 'Create a New Product'.'' | ||
|} | |} | ||
| Line 334: | Line 405: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''16. Afterward, choose your product type and product group from dropdown menus, fill in your product name and press '' 'Continue'.''''' |
|} | |} | ||
{| | {| | ||
| Line 340: | Line 411: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|'''17. Now, go to '' 'Module Settings' '' section, and choose both '' 'SolusVM 2 VPS & Cloud' '' and a previously created server group from the dropdown menus.''' |
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 347: | Line 417: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''18. Start configuration of a product with the '' 'General' '' section. |
| − | * | + | * First of all, choose the '''Product Type:''' '' 'VPS' '' or '' 'Cloud'.'' |
| − | * Next, select the desired '''Virtualization Type:''' '' 'KVM' '' or '' 'VZ' '' | + | * Next, select the desired '''Virtualization Type:''' '' 'KVM' '' or '' 'VZ'.'' |
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 356: | Line 425: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''19. Now, choose the general settings. |
| − | ''Note: | + | *'''Default User Role''' - new clients will be added to the SolusVM 2 panel, pick the role they will be assigned by default. |
| + | *'''Storage Type''' - select the storage type, options are defined in SolusVM 2 panel. | ||
| + | *'''Image Format''' - select the storage format, options are defined in SolusVM 2 panel.<br/>'''''Note:''' Some 'Storage Type' and 'Image Format' combinations may not support certain functions (e.g., snapshots), more information can be found in the [https://docs.solusvm.com/v2/quick-start-guide/Administration.html#3-adding-a-plan official SolusVM documentation].'' | ||
| + | *'''Location''' - select the server location, you can add more locations in the SolusVM 2 panel. | ||
| + | *'''Compute Resource''' - select the resource to be used, those can be prepared in the SolusVM 2 panel beforehand.<br/> You can also set it to '' 'Auto' '' to let SolusVM 2 decide which resource to use each time a virtual machine is created. | ||
|} | |} | ||
{| | {| | ||
| Line 363: | Line 436: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''20. Set up the limits on the virtual machine.'''<br/> |
| − | + | For both virtualization types, these are: | |
| + | *'''Virtual CPUs''' - number of virtual CPUs assigned. | ||
| + | *'''Disk Size''' - disk size reserved.<br/>'''''Note:''' Remember that there has to be at least 3GB of free space for the initial machine creation and at least 10GB for reinstallation.'' | ||
| + | *'''Memory''' - memory size of the virtual machine | ||
| + | *'''Additional IPv4 Addresses''' - additional ipV4 addresses to be added during creation. | ||
| + | *'''Additional IPv6 Addresses''' - additional ipV6 addresses to be added during creation. | ||
| + | *'''Backup Files''' - the maximum number of backup files, set it to '' '-1' '' to disable the limit. | ||
| + | Additionally, for the VZ virtualization type define: | ||
| + | *'''vCPU Units''' - this argument is used in the kernel fair scheduler. The larger the number is, the more CPU time the virtual machine gets relative to other virtual machines. | ||
| + | *'''vCPU Limit''' - the number of CPUs the virtual machines will be limited to. Enter '' '0' '' to disable the limit. | ||
| + | *'''IO Priority''' - this number determines the priority of the VM's I/O requests relative to I/O requests of other virtual machines. | ||
| + | *'''SWAP''' - the size of the SWAP file in MiB. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_15.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''21. Define the default configuration.''' |
| − | + | *'''Enable IPv4''' - decide if IPv4 protocol should be used. | |
| + | *'''Enable IPv6''' - decide if IPv6 protocol should be used. | ||
| + | *'''Operating System / Application''' - select the image to be used during creation. | ||
| + | *'''User Data''' - include any additional commands to be run during the first server boot.<br/>'''''Note:''' The commands depend on the system you choose, a list of WHMCS variables that can be used with the commands has been provided as well, e.g., $email'' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_16.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''22. Configure service-related options.''' |
| − | + | *'''Generate Password''' - Decide if you want the service password to be generated automatically. | |
| − | * | + | *'''Password Length''' - Define how long the password will be. |
| − | * | + | *'''Available Characters''' - Include characters available in the password generation process. By default, the field includes all characters permitted in SolusVM 2.<br/>We recommend only substracting from the default list, as adding new characters may result in validation issues. |
| − | + | '''Default Characters:''' | |
| − | * | + | abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*-_ |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_16_1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''23. Define features available in the client area by marking them in the '' 'Client Area Features' '' section.'''<br/> |
| − | To | + | The functions that can be made available: |
| + | *'''Start''' - allows clients to power on their virtual machines. | ||
| + | *'''Stop''' - lets clients shut down their virtual machines. | ||
| + | *'''Restart''' - enables clients to reboot their virtual machines. | ||
| + | *'''Shut Down''' - allows clients to turn off their virtual machines completely. | ||
| + | *'''Console''' - provides clients with access to their virtual machine’s console interface. | ||
| + | *'''Rescue Mode''' - lets clients enable or disable rescue mode on their virtual machines. | ||
| + | *'''Change Password''' - allows clients to update the root passwords of their virtual machines. | ||
| + | *'''Log In To Panel''' - enables clients to access the SolusVM 2 panel. | ||
| + | *'''Backups''' - allows clients to create and manage backups of their virtual machines. | ||
| + | *'''Graphs''' - displays performance and status graphs for virtual machines. | ||
| + | *'''Network''' - lets clients view IP addresses, gateways, nameservers, and set primary networks. | ||
| + | *'''Reinstallation''' - allows clients to reinstall their virtual machines with different systems or applications. | ||
| + | *'''Snapshots''' - enables clients to capture snapshots of their virtual machines.<br/>'''''Note:''' Snapshots can be taken on KVM virtualizations with LVM or ThinLVM storage types. If the image format is qcow2, File Based and NFS storage types can be used as well. | ||
| + | *'''Tasks''' - lets clients view the tasks performed on their virtual machines. | ||
| + | Images available for reinstallation: | ||
| + | *'''Available Operating Systems''' | ||
| + | *'''Available Applications''' | ||
|} | |} | ||
{| | {| | ||
| Line 399: | Line 499: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''24. Generate default configurable options.'''<br/> |
| + | To do so, press '' 'Generate' '' as shown on the screen below. You can choose which options to generate. Some options only work with virtual server [VS] virtualization type. <br/> | ||
| + | '''''Note:''' This step is optional. It is advisable not to generate options that you do not plan to use, or in case you want their fixed values to be taken from the module settings, rather than being flexible.''<br/> | ||
| + | When you are done with the module settings make sure to ''' 'Save Changes'.''' | ||
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_18.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px | + | |style="padding: 0px 0px 30px 15px;"|'''25. As the last step add a cron job as shown below (5-minute intervals are recommended).''' |
| + | php -q /your_whmcs/modules/servers/SolusVM2VpsCloud/cron/cron.php queue | ||
| + | This cron makes sure tasks are run automatically when in the queue.<br/> | ||
| + | Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location. The cron can be also executed every single minute in order to perform the action more often.<br/> | ||
| + | You will find personalized cron job information in the '' 'Queue' '' section of the addon. <br/><br/> | ||
| + | '''You have just finished the installation and configuration of the product, congratulations!''' | ||
|} | |} | ||
| − | + | ||
| − | = | + | =Management= |
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 30px 15px;"|'''You have just correctly created and customized a new product.'''<br/> Let us continue to the module management. The client area, the admin area and the addon will be described in detail in this section. |
|} | |} | ||
| + | ==Addon Configuration== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 30px 15px;"|'''Now we will highlight the features of the addon first.'''<br /> |
| + | Go to '' 'Addons' '' → '' 'SolusVM 2 VPS & Cloud' '' in your WHMCS to access it. | ||
|} | |} | ||
| + | ===Servers=== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 20px 15px;"|'' 'Servers' '' section contains a list of your configured servers, you may quickly edit them directly from this tab, simply press the edit icon.<br/> |
| + | The information displayed in the addon includes: | ||
| + | *'''Server name''' | ||
| + | *'''Server IP address''' | ||
| + | *'''Server active accounts number and limit''' | ||
| + | *'''Server status''' | ||
|} | |} | ||
{| | {| | ||
| Line 425: | Line 538: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Click on the '' 'OS Images & Applications Icons' '' button to view a list of images available on the server. <br/> |
| + | You can change the image associated with each operating system and application by clicking the '' 'Settings' '' icon and choosing a picture from the media library. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_21.png]] | ||
|} | |} | ||
| − | ===Library=== | + | ===Media Library=== |
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|The '' 'Media Library' '' section stores images that can be used as thumbnails for your operating system and application images. <br/> |
| + | Use the Additional Actions to delete all images at once. <br/> | ||
| + | To upload a new image, use the '' 'Upload Image' '' button. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_22.png]] |
|} | |} | ||
===Queue=== | ===Queue=== | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|In this section, you will find a list of all the tasks issued by the module.<br/> |
| + | The information on each task includes: | ||
| + | *'''Task ID''' | ||
| + | *'''Related item''' | ||
| + | *'''Task status''' | ||
| + | *'''Task type''' | ||
| + | *'''Attempts taken''' | ||
| + | *'''Date of creation''' | ||
| + | *'''Date of the last status update''' | ||
| + | You may also use the action buttons to: | ||
| + | *'''See task details''' | ||
| + | *'''Manually run the task''' | ||
| + | *'''Delete the task''' | ||
| + | To find specific tasks use the search and sorting functions. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23.png]] |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Task details include: | ||
| + | *'''Task ID''' | ||
| + | *'''Job''' | ||
| + | *'''Queue''' | ||
| + | *'''Retry Count''' | ||
| + | *'''Parent ID''' | ||
| + | *'''Type''' | ||
| + | *'''Related Item''' | ||
| + | *'''Custom Relation''' | ||
| + | *'''Status''' | ||
| + | *'''Retry After Date''' | ||
| + | *'''Created At Date''' | ||
| + | *'''Updated At Date''' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Related log entries can be found in a separate tab. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Tasks can also be deleted with the mass action function. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_3.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Additional actions include the '' 'Auto Prune' '' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_24.png]] | ||
|} | |} | ||
| − | == | + | ===[https://www.docs.modulesgarden.com/Translations_Tool Translations]=== |
| − | + | ||
| − | + | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/> |
| − | + | Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here]. | |
| − | + | |} | |
| − | + | {| | |
| − | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_25.png]] | |
| + | |} | ||
| − | The | + | <!--- |
| + | ===Logs=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|The '' 'Logs' '' page is where you will find detailed information about the actions the module is performing.<br/> | ||
| + | Use the action buttons to see details or delete each log entry. Multiple logs can be deleted at once by utilizing the mass selection function. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|Furthermore, the logs feature additional actions. Changing the logs' settings, exporting the logs to a '' '.csv' '' file, and a way to delete specific log types. |
|} | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|In the settings you can specify which log types should be recorded, and whether they should be deleted automatically after a specific time. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|While exporting you will pick a time frame and the log types to export. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_3.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Here you can decide which log types to delete, you can also specify how old the logs have to be to qualify for deletion. Leave the first field empty to delete all logs. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_26_4.png]] | ||
| + | |} | ||
| + | ---> | ||
| − | == | + | ==Admin Area== |
| − | === | + | ===VPS=== |
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the virtual machines on the client's page.<br/> |
| + | The action buttons include: | ||
| + | *'''Start the machine''' | ||
| + | *'''Stop the machine''' | ||
| + | *'''Shut down the machine''' | ||
| + | *'''Restart the machine''' | ||
| + | *'''Access the machine's console interface''' | ||
| + | *'''Log in to SolusVM 2 panel''' | ||
| + | *'''Enable/Disable Rescue Mode''' | ||
| + | *'''Change the password of the machine''' | ||
| + | *'''Import From SolusVM 2.0 WHMCS Addon''' <br/>'''''Note:''' Only available before a virtual machine is created in the new service, allows you to import an existing machine.'' | ||
| + | Underneath the information regarding the virtual machine is located, it includes: | ||
| + | *'''Status of the machine''' | ||
| + | *'''Hostname''' | ||
| + | *'''vCPUs in use''' | ||
| + | *'''Disk space allocated to the machine''' | ||
| + | *'''Operating system/application currently used''' | ||
| + | All tasks from the SolusVM 2 panel are logged in the '' 'Tasks' '' table. The '' 'Queue' '' table lists the tasks issued by the module. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_27.png]] |
|} | |} | ||
| + | ===Cloud=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the machines on the client's page.<br/> | ||
| + | The '''Available Resources''' graph displays how much of the distributed resources are in use.<br/> | ||
| + | The '''Virtual Machine list''' features details about the client's servers and offers options to: | ||
| + | *'''Start the machine''' | ||
| + | *'''Stop the machine''' | ||
| + | *'''Shutdown the machine''' | ||
| + | *'''Restart the machine''' | ||
| + | *'''Toggle Rescue Mode on the machine''' | ||
| + | *'''Open Console of the machine''' | ||
| + | and import new virtual machines.<br/>'''''Note:''' Including an option to import from the SolusVM 2.0 WHMCS Addon''<br/> | ||
| + | All tasks from the SolusVM 2 panel are logged in the '' 'Tasks' '' table.<br/> | ||
| + | The '' 'Queue' '' table lists the tasks issued by the module.<br/> | ||
| + | '''''Note:''' Keep in mind that the 'Suspend' module command will suspend all machines.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_28.png]] | ||
| + | |} | ||
| + | ==Client Area - VPS== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|For the VPS products, clients have access to basic actions and information regarding their virtual machine. <br/> | ||
| + | The basic actions include: | ||
| + | *'''Start''' | ||
| + | *'''Stop''' | ||
| + | *'''Shut Down''' | ||
| + | *'''Restart''' | ||
| + | *'''Open Console''' | ||
| + | *'''Log in To Panel''' | ||
| + | *'''Toggle Rescue Mode''' | ||
| + | *'''Change Password''' | ||
| + | If enabled, additional tools will also be available to the user. <br/> | ||
| + | The current information about the virtual machine is displayed in the '' 'Information' '' table. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_29.png]] | ||
| + | |} | ||
===Backups=== | ===Backups=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Users can create and manage backups in the '' 'Backups' '' tab. <br/> |
| − | To | + | To create a new backup use the '' 'Create Backup' '' button. <br/> |
| + | Once a backup is created, it can be deleted or used to restore the virtual machine state by clicking the action buttons next to each backup on the list.<br/> | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_30.png]] |
|} | |} | ||
===Graphs=== | ===Graphs=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Clients will find visualizations of their current '' 'CPU Usage', 'Disk Throughput' '', '' 'Network Throughput' '' and '' 'Memory Usage'.''<br/> |
| − | + | By tracking VPS usage sudden and unexpected overloads can be avoided. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_31.png]] |
|} | |} | ||
===Network=== | ===Network=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|The network tab contains information regarding the virtual machine's network settings. |
| − | + | *'''IP Address''' | |
| + | *'''Gateway''' | ||
| + | *'''Primary Name Server''' | ||
| + | *'''Secondary Name Server''' | ||
| + | and whether a given network is set as a primary for the virtual machine. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_32.png]] |
|} | |} | ||
| + | |||
| + | ===Reinstallation=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|The '' 'Reinstall' '' tab contains a list of operating systems and applications allowed for virtual machine reinstallation.<br/> | ||
| + | Clicking on any of the icons will initiate the reinstallation process, after a confirmation popup. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_33.png]] | ||
| + | |} | ||
| + | |||
| + | ===Snapshots=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|The '' 'Snapshot' '' tab allows the users to create new snapshots and manage their snapshot library.<br/> | ||
| + | Use the '' 'Create Snapshot' '' button to take a new snapshot. <br/> | ||
| + | The action buttons below can be used to restore a snapshot or delete it. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_34.png]] | ||
| + | |} | ||
| + | |||
| + | ===Tasks=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|The list of tasks related to the client's virtual machine can be found in the '' 'Tasks' '' tab.<br/> | ||
| + | The list features details such as: | ||
| + | *'''Task start time''' | ||
| + | *'''Task finish time''' | ||
| + | *'''Action''' | ||
| + | *'''Status''' | ||
| + | *'''Duration''' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_35.png]] | ||
| + | |} | ||
| + | |||
==Client Area - Cloud Type== | ==Client Area - Cloud Type== | ||
| − | === | + | {| |
| + | |style="padding: 10px 0px 15px 15px;"|The client area of cloud products features '' 'Available Resources' '' information table and the '' 'Virtual Servers' '' list. <br/> | ||
| + | The table features a graphical representation of the resource usage of | ||
| + | *'''vCPUs cores''' | ||
| + | *'''Disk limits''' | ||
| + | *'''Memory limits''' | ||
| + | *'''Additional IPv4 addresses''' | ||
| + | *'''Additional IPv6 addresses''' | ||
| + | Hovering over the question mark icon will display the exact numbers for each metric. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_36.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Action buttons allow managing, deleting, and performing actions on existing servers. | ||
| + | *'''Manage Virtual Server''' - opens the details page where changes can be introduced. | ||
| + | *'''Delete''' - starts the task of deleting the server. | ||
| + | *'''Additional Actions''' - allows actions such as: '' 'Start ','' '' 'Stop','' '' 'Shut Down','' '' 'Restart','' '' 'Toggle Rescue Mode','' and '' 'Open Console'.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_36_1.png]] | ||
| + | |} | ||
| + | ===New Virtual Machine=== | ||
{| | {| | ||
|style="padding: 10px 0px 20px 15px;"| | |style="padding: 10px 0px 20px 15px;"| | ||
| − | + | To add a new virtual machine, click on the '' 'Create Virtual Machine' '' button first. | |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_37.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Then provide the configuration for the new virtual machine. |
| + | *'''Hostname''' | ||
| + | *'''Password''' | ||
| + | *'''SSH Key''' | ||
| + | *'''vCPUs''' | ||
| + | *'''Disk Size''' | ||
| + | *'''RAM''' | ||
| + | *'''Primary IPv4''' | ||
| + | *'''Primary IPv6''' | ||
| + | *'''Additional IPv4''' | ||
| + | *'''Additional IPv6''' | ||
| + | *'''Image''' | ||
| + | The graph on the top of the screen can help you see how many resources remain while you allocate them to the new machine.<br/> | ||
| + | Click on '' 'Submit' '' when ready. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:SVM2_38.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|You can also manage a machine directly and use additional tools, after selecting it on the side menu. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:SVM2_39.png]] |
|} | |} | ||
| − | + | {| | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=Tips= | =Tips= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 5px 15px;"|1. | + | |style="padding: 10px 0px 5px 15px;"|1. Since the SolusVM 2 panel only allows a small number of special signs to be used in passwords, it might be helpful to disable special characters in auto-generated passwords.<br/>To do so, navigate to '' 'General Settings' '' → '' 'Security' '' → '' 'Auto Generated Password Format' '' and select '' 'Generate passwords containing a combination of letters and numbers only'.'' |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 5px 15px;"|2. You can add an SSH Key for a virtual machine using a <code>sshKey|SSH Public Key</code> custom field for the VPS functionality. <br/>For the Cloud functionality, the option to add an SSH Key is available when creating a new virtual machine. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|3. SolusVM 2 VPS & Cloud module can manage virtual machines imported from SolusVM 2.0 WHMCS addon.<br/> To import your machines use the '' 'Import From SolusVM 2.0 WHMCS Addon' '' button found in the admin area.<br/> For VPS products this option is available after service has been activated, but the machine has not been created yet. | ||
|} | |} | ||
| Line 551: | Line 864: | ||
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/> | |style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/> | ||
| − | Opt for the [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps#open-source-version Open Source version] of your SolusVM | + | Opt for the [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps#open-source-version Open Source version] of your SolusVM 2 VPS & Cloud For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/> |
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. | Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. | ||
Latest revision as of 14:55, 16 April 2025
Contents |
[edit] About SolusVM 2 VPS & Cloud For WHMCS
| SolusVM 2 VPS & Cloud For WHMCS module offers provisioning of virtual machines as single VPS instances or flexible Cloud resources. Allow your clients to create and manage servers within their limits using efficient tools for backups, snapshots, reinstallations, and real-time performance monitoring. |
- Admin Area Features:
| ✔ Create/Suspend/Unsuspend/Terminate Product |
| ✔ Change Package |
| ✔ Change Password |
| ✔ Import Virtual Machine (Cloud) |
| ✔ Existing Virtual Machines |
| ✔ From SolusVM 2.0 WHMCS Addon |
| ✔ View Available Resources (Cloud) |
| ✔ Start/Stop/Pause/Unpause/Resume Servers |
| ✔ Access noVNC Console |
| ✔ Enable/Disable Rescue Mode |
| ✔ View Servers Status And Details |
| ✔ View Scheduled And Completed Tasks |
| ✔ View Queue |
| ✔ Provide Product General Configuration: |
| ✔ Select Product Type: |
| ✔ VPS - Provisioning Of Single Server Per Product |
| ✔ Cloud - Enable Provisioning Of Multiple Servers Per Single Product |
| ✔ Select Virtualization Type: |
| ✔ KVM |
| ✔ VZ |
| ✔ Define Image Format |
| ✔ Select Compute Resource |
| ✔ Select Default User Role |
| ✔ Select Storage Type |
| ✔ Select Server Location |
| ✔ Define Server Limits: |
| ✔ Virtual CPUs |
| ✔ vCPU Units (VZ) |
| ✔ vCPU Limit (VZ) |
| ✔ Disk Size [GiB] |
| ✔ Memory [MiB] |
| ✔ IO Priority (VZ) |
| ✔ SWAP [MiB] (VZ) |
| ✔ Additional IPv4 Addresses |
| ✔ Additional IPv6 Addresses |
| ✔ Define Default Server Configuration: |
| ✔ Enable IPv4 And IPv6 |
| ✔ Provide User Data Script |
| ✔ Select Default Operating System / Application |
| ✔ Enable Access To Client Area Features: |
| ✔ Backups |
| ✔ Graphs |
| ✔ Network |
| ✔ Reinstall |
| ✔ Snapshots |
| ✔ Tasks |
| ✔ Select Available Operation Systems |
| ✔ Select Available Applications |
| ✔ Select Server Information Entries |
| ✔ Generate Configurable Options |
- Addon Features:
| ✔ View Server Configurations Lists And Details: |
| ✔ IP Address |
| ✔ Active Accounts |
| ✔ Status |
| ✔ Customize Operation System And Application Logo Images |
| ✔ View Queue Of Scheduled Tasks And Details |
| ✔ Customize Module Language Files With "Translations" Tool |
| ✔ View And Manage Logs |
- Client Area Features:
| ✔ Manage Single (VPS) Or Multiple (Cloud) Servers Per Product |
| ✔ View Servers Status And Details |
| ✔ View Available Resources (Cloud) |
| ✔ Start/Stop/Restart Servers |
| ✔ Access noVNC Console |
| ✔ Enable/Disable Rescue Mode |
| ✔ Change Server Password |
| ✔ Create/Manage/Restore Backups |
| ✔ View Server Graphs: |
| ✔ CPU Usage |
| ✔ Disk Throughput |
| ✔ Network Throughput |
| ✔ Memory Usage |
| ✔ View Network Details |
| ✔ Reinstall Server Using: |
| ✔ Operating Systems |
| ✔ Applications |
| ✔ Create/Manage/Revert Snapshots |
| ✔ View Scheduled And Completed Tasks |
- Configurable Options:
| ✔ Virtual CPUs |
| ✔ Limit of CPU [VZ] |
| ✔ CPU Units for the VS |
| ✔ Disk Size |
| ✔ Amount of RAM |
| ✔ Amount of SWAP [VZ] |
| ✔ IO Priority [VZ] |
| ✔ Additional IPv4 Addresses |
| ✔ Additional IPv6 Addresses |
| ✔ OS / Application |
- General Info:
| ✔ Multi-Language Support With Custom Translations Tool |
| ✔ Supports PHP 8.2 Back To PHP 8.1 |
| ✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme" |
| ✔ Supports WHMCS V8.12 Back To WHMCS V8.9 |
| ✔ Requires ionCube Loader V14 Or Later |
| ✔ Easy Module Upgrade To Open Source Version |
[edit] Installation and Configuration
| In this tutorial we will show you how to successfully install SolusVM 2 VPS & Cloud For WHMCS. We will guide you step by step through the whole installation and configuration process. |
| 1. Log in to our client area and download the module. |
|
| 3. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this. |
|
| 4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in '/modules/servers/SolusVM2VpsCloud/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
|
| 5. In order to configure your license key, you have to edit a previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'. |
|
| 6. In the next step, set up the 'storage' folder as recursively writable. This folder is available at 'your_whmcs/modules/servers/SolusVM2VpsCloud/storage'. |
|
[edit] Activation of SolusVM 2 VPS & Cloud Addon
| 7. Firstly, activate the SolusVM 2 VPS & Cloud addon. To do so, log in to your WHMCS and navigate to 'System Settings' →'Addon Modules'. Find 'SolusVM 2 VPS & Cloud' 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'. |
|
[edit] Configuration of Server
| 9. Now, log in to your WHMCS admin area and proceed to 'System Settings' → 'Servers'. Afterward, press 'Add New Server'. |
|
10. Enter your server name and IP address.
Check Secure option if your server uses an SSL connection. |
|
| 11. Now, you need to create a new group for your server. For that purpose press 'Create New Group'. |
|
| 12. Fill in name, choose a previously created server and press 'Add'. Confirm by clicking on 'Save Changes'. |
|
[edit] Configuration of Product
| 13. In order to create and configure product, go to 'System Settings' → 'Products/Services'. Afterwards, click on 'Create a New Group'. |
|
| 14. Fill in a product group name and press 'Save Changes'. |
|
| 15. When you have a product group, you can create your product and assign it to SolusVM 2 VPS & Cloud. To create a product click on 'Create a New Product'. |
|
| 16. Afterward, choose your product type and product group from dropdown menus, fill in your product name and press 'Continue'. |
|
| 17. Now, go to 'Module Settings' section, and choose both 'SolusVM 2 VPS & Cloud' and a previously created server group from the dropdown menus. |
|
18. Start configuration of a product with the 'General' section.
|
|
19. Now, choose the general settings.
|
|
| 20. Set up the limits on the virtual machine. For both virtualization types, these are:
Additionally, for the VZ virtualization type define:
|
|
21. Define the default configuration.
|
|
22. Configure service-related options.
Default Characters: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*-_ |
|
| 23. Define features available in the client area by marking them in the 'Client Area Features' section. The functions that can be made available:
Images available for reinstallation:
|
|
| 24. Generate default configurable options. To do so, press 'Generate' as shown on the screen below. You can choose which options to generate. Some options only work with virtual server [VS] virtualization type. |
|
25. As the last step add a cron job as shown below (5-minute intervals are recommended).
php -q /your_whmcs/modules/servers/SolusVM2VpsCloud/cron/cron.php queue This cron makes sure tasks are run automatically when in the queue. |
[edit] Management
| You have just correctly created and customized a new product. Let us continue to the module management. The client area, the admin area and the addon will be described in detail in this section. |
[edit] Addon Configuration
| Now we will highlight the features of the addon first. Go to 'Addons' → 'SolusVM 2 VPS & Cloud' in your WHMCS to access it. |
[edit] Servers
| 'Servers' section contains a list of your configured servers, you may quickly edit them directly from this tab, simply press the edit icon. The information displayed in the addon includes:
|
|
| Click on the 'OS Images & Applications Icons' button to view a list of images available on the server. You can change the image associated with each operating system and application by clicking the 'Settings' icon and choosing a picture from the media library. |
|
[edit] Media Library
| The 'Media Library' section stores images that can be used as thumbnails for your operating system and application images. Use the Additional Actions to delete all images at once. |
|
[edit] Queue
| In this section, you will find a list of all the tasks issued by the module. The information on each task includes:
You may also use the action buttons to:
To find specific tasks use the search and sorting functions. |
|
Task details include:
|
|
| Related log entries can be found in a separate tab. |
|
| Tasks can also be deleted with the mass action function. |
|
| Additional actions include the 'Auto Prune' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information. |
|
[edit] Translations
| Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon. Its user-friendly design makes managing various language file tweaks a smooth and efficient process. Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here. |
|
[edit] Admin Area
[edit] VPS
| Admins can monitor and manage the virtual machines on the client's page. The action buttons include:
Underneath the information regarding the virtual machine is located, it includes:
All tasks from the SolusVM 2 panel are logged in the 'Tasks' table. The 'Queue' table lists the tasks issued by the module. |
|
[edit] Cloud
| Admins can monitor and manage the machines on the client's page. The Available Resources graph displays how much of the distributed resources are in use.
and import new virtual machines. |
|
[edit] Client Area - VPS
| For the VPS products, clients have access to basic actions and information regarding their virtual machine. The basic actions include:
If enabled, additional tools will also be available to the user. |
|
[edit] Backups
| Users can create and manage backups in the 'Backups' tab. To create a new backup use the 'Create Backup' button. |
|
[edit] Graphs
| Clients will find visualizations of their current 'CPU Usage', 'Disk Throughput' , 'Network Throughput' and 'Memory Usage'. By tracking VPS usage sudden and unexpected overloads can be avoided. |
|
[edit] Network
The network tab contains information regarding the virtual machine's network settings.
and whether a given network is set as a primary for the virtual machine. |
|
[edit] Reinstallation
| The 'Reinstall' tab contains a list of operating systems and applications allowed for virtual machine reinstallation. Clicking on any of the icons will initiate the reinstallation process, after a confirmation popup. |
|
[edit] Snapshots
| The 'Snapshot' tab allows the users to create new snapshots and manage their snapshot library. Use the 'Create Snapshot' button to take a new snapshot. |
|
[edit] Tasks
| The list of tasks related to the client's virtual machine can be found in the 'Tasks' tab. The list features details such as:
|
|
[edit] Client Area - Cloud Type
| The client area of cloud products features 'Available Resources' information table and the 'Virtual Servers' list. The table features a graphical representation of the resource usage of
Hovering over the question mark icon will display the exact numbers for each metric. |
|
Action buttons allow managing, deleting, and performing actions on existing servers.
|
|
[edit] New Virtual Machine
|
To add a new virtual machine, click on the 'Create Virtual Machine' button first. |
|
Then provide the configuration for the new virtual machine.
The graph on the top of the screen can help you see how many resources remain while you allocate them to the new machine. |
|
| You can also manage a machine directly and use additional tools, after selecting it on the side menu. |
|
| 1. Since the SolusVM 2 panel only allows a small number of special signs to be used in passwords, it might be helpful to disable special characters in auto-generated passwords. To do so, navigate to 'General Settings' → 'Security' → 'Auto Generated Password Format' and select 'Generate passwords containing a combination of letters and numbers only'. |
2. You can add an SSH Key for a virtual machine using a sshKey|SSH Public Key custom field for the VPS functionality. For the Cloud functionality, the option to add an SSH Key is available when creating a new virtual machine. |
| 3. SolusVM 2 VPS & Cloud module can manage virtual machines imported from SolusVM 2.0 WHMCS addon. To import your machines use the 'Import From SolusVM 2.0 WHMCS Addon' button found in the admin area. For VPS products this option is available after service has been activated, but the machine has not been created yet. |
[edit] Update Instructions
| An essential guidance through the process of updating the module is offered here. Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues. |
[edit] Upgrade Guide
| Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability? There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment. Opt for the Open Source version of your SolusVM 2 VPS & Cloud For WHMCS module to unlock these benefits. Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. |
[edit] Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |