EasyDCIM Dedicated Servers For WHMCS
Line 1: | Line 1: | ||
− | |||
− | |||
<meta name="keywords" content="easydcim dedicated servers for whmcs, easydcim dedicated servers configuration, whmcs easydcim dedicated servers management, whmcs easydcim dedicated servers installation, whmcs easydcim dedicated servers common problems, about whmcs easydcim dedicated servers, whmcs easydcim dedicated servers documentation, whmcs easydcim dedicated servers faq, whmcs easydcim dedicated servers help, whmcs easydcim dedicated servers guide, whmcs easydcim dedicated servers wiki, whmcs easydcim dedicated servers tutorial, whmcs easydcim dedicated servers tips, whmcs easydcim dedicated servers wiki"></meta> | <meta name="keywords" content="easydcim dedicated servers for whmcs, easydcim dedicated servers configuration, whmcs easydcim dedicated servers management, whmcs easydcim dedicated servers installation, whmcs easydcim dedicated servers common problems, about whmcs easydcim dedicated servers, whmcs easydcim dedicated servers documentation, whmcs easydcim dedicated servers faq, whmcs easydcim dedicated servers help, whmcs easydcim dedicated servers guide, whmcs easydcim dedicated servers wiki, whmcs easydcim dedicated servers tutorial, whmcs easydcim dedicated servers tips, whmcs easydcim dedicated servers wiki"></meta> | ||
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Dedicated Servers For WHMCS Module."></meta> | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Dedicated Servers For WHMCS Module."></meta> | ||
Line 138: | Line 136: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 30px;"|✔ OS Template | |style="padding: 0px 0px 0px 30px;"|✔ OS Template | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Service Access (Hidden By Default | ||
|} | |} | ||
{| | {| | ||
Line 155: | Line 156: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ CPU Cores |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Custom - To Be Displayed In EasyDCIM Service Configuration | ||
+ | |} | ||
+ | |||
+ | *'''Advanced Billing Integration:''' | ||
+ | {| | ||
+ | |style="padding: 10px 0px 0px 30px;"|✔ Bill For Current Bandwidth Usage | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of Bandwidth Overages | ||
|} | |} | ||
*'''General Info:''' | *'''General Info:''' | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support | + | |style="padding: 10px 0px 0px 30px;"| ✔ Integrated With <u>Advanced Billing For WHMCS</u> v3.2.2 And Later - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing#features (read more)] |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"| ✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator#features (read more)] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.4. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.4.3 and Later |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
|} | |} | ||
Line 187: | Line 205: | ||
|style="padding: 0px 0px 20px 25px;"|[[File:ED_1.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:ED_1.png]] | ||
|} | |} | ||
+ | <!-- z uwagi na opensource paczki nie sa juz kodowane wiec OUT | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |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''': You can check current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' | + | '' '''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 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
|} | |} | ||
+ | --> | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the files into the main WHMCS directory.'''<br /> |
− | + | Files in your WHMCS directory should look like on the following screen. | |
|} | |} | ||
{| | {| | ||
Line 204: | Line 224: | ||
==Configuration of Server== | ==Configuration of Server== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''3. Now, we will show you how to configure a new product.'''<br/> |
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press the '' 'Add New Server' '' button. | Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press the '' 'Add New Server' '' button. | ||
|} | |} | ||
Line 211: | Line 231: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''4. Next, choose '' 'EasyDCIM' '' from the '' 'Type' '' dropdown menu.<br/> |
Fill in your server name, IP address, username and password, then press '' 'Save Changes'.''<br/> | Fill in your server name, IP address, username and password, then press '' 'Save Changes'.''<br/> | ||
'' '''Note:''' The password can be found in your EasyDCIM administrator user profile listed as '[https://www.docs.modulesgarden.com/images/9/99/E_API_Key.png API Key]'. '' | '' '''Note:''' The password can be found in your EasyDCIM administrator user profile listed as '[https://www.docs.modulesgarden.com/images/9/99/E_API_Key.png API Key]'. '' | ||
Line 219: | Line 239: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''5. After configuring your server, you can check the connection.'''<br/> |
In order to check the connection with an EasyDCIM server, edit the server configuration and press '' 'Test Connection' '' as shown on the screen below. | In order to check the connection with an EasyDCIM server, edit the server configuration and press '' 'Test Connection' '' as shown on the screen below. | ||
|} | |} | ||
Line 226: | Line 246: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''6. The next step is creating a server group. To do so, click on '' 'Create Server Group'.'' |
|} | |} | ||
{| | {| | ||
Line 232: | Line 252: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''7. Enter the name, click on your previously created server, press '' 'Add' '' and '' 'Save Changes' '' afterwards. |
|} | |} | ||
{| | {| | ||
Line 309: | Line 329: | ||
|style="padding: 0px 0px 15px 15px;"|'''15. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.<br/> | |style="padding: 0px 0px 15px 15px;"|'''15. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.<br/> | ||
We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/> | We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/> | ||
− | '' '''Note:''' Any configurable option will overwrite its counterpart from the product's 'Module Settings'.'' | + | '' '''Note:''' You can also add '''your own''' configurable options, which will be then displayed under 'Service Configuration' in your EasyDCIM backend.''<br/> |
+ | '' '''Important:''' Any configurable option will overwrite its counterpart from the product's 'Module Settings'.'' | ||
|} | |} | ||
{| | {| | ||
Line 316: | Line 337: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''16. Additionally, you can set up a percentile billing for additional traffic.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''16. Additionally, you can set up a percentile billing for additional traffic.'''<br /> | ||
+ | '' '''Note:''' This is only enabled, if you do '''not''' have [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing Form WHMCS] module installed. If you need a bit more advanced billing integration, please go [https://www.docs.modulesgarden.com/EasyDCIM_Dedicated_Servers_For_WHMCS#Advanced_Billing_Integration here] for more information. <br/> | ||
Go to the '' 'Other' '' tab, enable '' 'Overages Billing' ''. First, define the standard [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing overages bandwidth billing] and then set the following percentile values: | Go to the '' 'Other' '' tab, enable '' 'Overages Billing' ''. First, define the standard [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing overages bandwidth billing] and then set the following percentile values: | ||
*Soft Limit - bandwidth usage in Mbps, after which the customer will be additionally charged for the used transfer | *Soft Limit - bandwidth usage in Mbps, after which the customer will be additionally charged for the used transfer | ||
Line 360: | Line 382: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Below the mentioned functions, there are various usage graphs available at your disposal. | + | |style="padding: 0px 0px 20px 15px;"|Below the mentioned functions, there are various usage graphs and statistics available at your disposal.<br/> |
+ | '' '''Note:''' By default, there are 5 types of statistics displayed. If you need more you can add them though the '''configuration.json''' file located in /yourWHMCS/modules/servers/EasyDCIM/Config. '' | ||
|} | |} | ||
{| | {| | ||
Line 422: | Line 445: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:ED_27.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:ED_27.png]] | ||
+ | |} | ||
+ | |||
+ | =Advanced Billing Integration= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 20px 15px;"|EasyDCIM Colocation For WHMCS supports integration with the [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] module.<br/>This allows you to charge your customers for total bandwidth and 95th percentile billing for additional traffic.<br/> | ||
+ | |||
+ | '' '''Note:''' We suggest to run the cron '''only once per hour''' (with the interval of 3600 seconds).<br/>This is due to the fact that while generating an invoice, '''only the last billed record''' is taken into account, so there is no need to collect data more often. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:ED_28.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Once the [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS#Usage_Records relevant options] are enabled, your clients will also be able to view billing for the current usage in your client area. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:ED_39.png]] | ||
|} | |} | ||
Line 435: | Line 474: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"|3. Since the 1.3.0 version, the '' 'monthlyTrafficLimit|Monthly Traffic Limit' '' configurable option has been changed to '' 'Bandwidth|Bandwidth' ''. <br /> Remember to change it manually after updating the module. |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 15px;"|4. In '' '/yourWHMCS/modules/servers/EasyDCIM/Config' '' location you can find 3 additional config files:<br/> | ||
+ | - ''configuration.json'' - where you can set created user role ('2' by default) as well as add and manage graphs diplayed in client and admin area<br/> | ||
+ | - ''emailTemplates.json'' - where you can edit email templates that are automatiacally created after first run of EasyDCIM module<br/> | ||
+ | - ''hooks.json'' - where you can activate/deactivate hooks used by the module or add your own | ||
|} | |} | ||
Revision as of 17:10, 11 April 2018
Contents |
About EasyDCIM Dedicated Servers For WHMCS
EasyDCIM Dedicated Servers For WHMCS will allow you to move the provisioning and management of EasyDCIM servers directly to your WHMCS. The module will let you handle all crucial aspects of created servers, including their status and the SSH password. |
- Admin Area Features:
✔ Create/Terminate/Suspend/Unsuspend Server |
✔ Boot/Reboot/Shutdown Server |
✔ Change Server SSH Access Details |
✔ View Server Details |
✔ View Server Resource Usage Graphs |
✔ Generate Default Configurable Options |
✔ Configure Server: |
✔ Server Model |
✔ Server Location |
✔ OS Template |
✔ Server Resources |
✔ Toggle Automatic Order Acceptance And Server Matching |
✔ Define Required Devices |
✔ Define Required Item Models: |
✔ HDD Model |
✔ SSD Model |
✔ RAM Model |
✔ CPU Model |
✔ Define Client Area Features |
✔ Choose OS Templates Available For Rebuilding |
✔ Choose OS Templates Available For Rebuilding |
✔ Control Service Actions And Email Notifications |
✔ Determine Monthly Interval Of Bandwidth Usage |
✔ Define Percentile Billing Of Bandwidth Overage |
✔ One Click Login To EasyDCIM: |
✔ User Control Panel |
✔ Admin Panel |
✔ Toggle Debug Mode |
- Client Area Features:
✔ Boot/Reboot/Shutdown Server |
✔ Receive Email Notification On Complete Server Creation |
✔ Change Server Hostname |
✔ Change Server SSH Password |
✔ View Server Details |
✔ Access KVM Console (Dell And SuperMicro Servers) |
✔ Rebuild Server OS Using OS Templates And Your Own Credentials |
✔ View Server Resource Usage Graphs |
✔ View Traffic Statistics |
✔ One Click Login To User Control Panel |
- Configurable Options:
✔ Server Model |
✔ Server Location |
✔ OS Template |
✔ Service Access (Hidden By Default |
✔ Bandwidth |
✔ Additional IP Addresses |
✔ HDD Size |
✔ SSD Size |
✔ RAM Size |
✔ CPU Cores |
✔ Custom - To Be Displayed In EasyDCIM Service Configuration |
- Advanced Billing Integration:
✔ Bill For Current Bandwidth Usage |
✔ Apply 95th Percentile Billing Of Bandwidth Overages |
- General Info:
✔ Integrated With Advanced Billing For WHMCS v3.2.2 And Later - Actual Server Resource Usage Billing (read more) |
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more) |
✔ Multi-Language Support |
✔ Supports EasyDCIM v1.4.3 and Later |
✔ Supports PHP 5.6 Up To PHP 7.2 |
✔ Supports WHMCS Template Six |
✔ Supports WHMCS V7 |
Installation and Configuration
This tutorial will show you how to successfully install and configure EasyDCIM For WHMCS. We will guide you step by step through the whole installation and configuration process. |
Installation
1. Log in to our client area and download the module. |
![]() |
2. Upload and extract the files into the main WHMCS directory. Files in your WHMCS directory should look like on the following screen. |
![]() |
Configuration of Server
3. Now, we will show you how to configure a new product. Go to 'Setup' → 'Products/Services' → 'Servers' and press the 'Add New Server' button. |
![]() |
4. Next, choose 'EasyDCIM' from the 'Type' dropdown menu. Fill in your server name, IP address, username and password, then press 'Save Changes'. |
![]() |
5. After configuring your server, you can check the connection. In order to check the connection with an EasyDCIM server, edit the server configuration and press 'Test Connection' as shown on the screen below. |
![]() |
6. The next step is creating a server group. To do so, click on 'Create Server Group'. |
![]() |
7. Enter the name, click on your previously created server, press 'Add' and 'Save Changes' afterwards. |
![]() |
Configuration of Product
9. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services'. Click on 'Create a New Group'. |
![]() |
10. Enter the product group name and press 'Save Changes'. |
![]() |
11. Once you have a product group, you can assign your product to it. To create a product, click on 'Create a New Product'. |
![]() |
12. Next, choose your product group, enter your product name and then press 'Continue'. |
![]() |
13. Now, go to the 'Module Settings' section, choose both 'EasyDCIM' and your previously created server group from dropdown menus. Do not forget to click 'Save Changes'. |
![]() |
14. Before configuring the product, set up the EasyDCIM cron job which can be found here. |
![]() |
15. The module configuration is only partly obligatory. The server will be assigned based on the provided configuration, and will therefore match only those options that have been specified.
Default Options:
Product Configuration
Items Model
Client Area Features
Service Actions
Service Notification
|
![]() |
15. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs. We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under 'Setup' → 'Products/Services' → 'Configurable Options'. |
![]() |
16. Additionally, you can set up a percentile billing for additional traffic. Note: This is only enabled, if you do not have Advanced Billing Form WHMCS module installed. If you need a bit more advanced billing integration, please go here for more information.
E.g. If 'Soft Limit = 100' and 'Cost = 0.500' and the client exceed the bandwidth to '110 Mbps' , it means that they will be additionally charged with $5 USD amount (10 x 0.500). |
![]() |
Custom Fields
Once the configuration of the module settings has been completed, the following custom fields will be created automatically. Note: These fields will not be visible to clients by default.
|
![]() |
Management
In this section we will show you all the possibilities of EasyDCIM Dedicated Servers For WHMCS. Our module allows you to offer and manage EasyDCIM servers right in your WHMCS system. |
Admin Area
As soon as you set up a server for a client, you can request various actions and view server details from WHMCS admin area. |
![]() |
Our module allows you to boot/reboot/shutdown server as well as view its details. |
![]() |
Below the mentioned functions, there are various usage graphs and statistics available at your disposal. Note: By default, there are 5 types of statistics displayed. If you need more you can add them though the configuration.json file located in /yourWHMCS/modules/servers/EasyDCIM/Config. |
![]() |
Client Area
In the client area, your customers can view all details concerning their servers, manage their status remotely as well as log in to their EasyDCIM control panel with a single click. |
![]() |
Additionally, you can explore several usage graphs. |
![]() |
You can also view information about the traffic billing. Note: Available time intervals depend on the date of the product registration. |
![]() |
As well as reinstall OS on your server. |
![]() |
Moreover, it is possible to control your reverse DNS. You can either edit the already existing records or create new ones. |
![]() |
To create a record, just fill in the necessary information. |
![]() |
Your newly created record will appear on the list. |
![]() |
If you are using Dell or SuperMicro servers you can also access the KVM console. |
![]() |
It will launch a Java applet that will automatically connect to your server. Note: Your browser needs to have Java enabled with the correct permissions to make the console functioning. |
![]() |
Advanced Billing Integration
EasyDCIM Colocation For WHMCS supports integration with the Advanced Billing For WHMCS module. This allows you to charge your customers for total bandwidth and 95th percentile billing for additional traffic. Note: We suggest to run the cron only once per hour (with the interval of 3600 seconds). |
![]() |
Once the relevant options are enabled, your clients will also be able to view billing for the current usage in your client area. |
![]() |
Tips
1. Note that placing two identical orders may result in assigning servers with slightly different parameters.
It stems from the way EasyDCIM server matching works. It matches a server basing on the resources and models mentioned in the order, without considering other resources. |
2. As this server supports the templates system, any changes made in the server's templates files will be saved after the upgrade process. |
3. Since the 1.3.0 version, the 'monthlyTrafficLimit|Monthly Traffic Limit' configurable option has been changed to 'Bandwidth|Bandwidth' . Remember to change it manually after updating the module. |
4. In '/yourWHMCS/modules/servers/EasyDCIM/Config' location you can find 3 additional config files: - configuration.json - where you can set created user role ('2' by default) as well as add and manage graphs diplayed in client and admin area |
Update Instructions
Essential guidance through the process of updating the module is offered here. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |