Personal tools
Namespaces

Variants
Actions

DigitalOcean Droplets For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation)
Line 12: Line 12:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Server
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Server
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Migrate Server Between Nodes
 
 
|}
 
|}
 
{|
 
{|
Line 20: Line 17:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password - Xen Virtualization Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign/Delete Virtual Machine By Name
+
|style="padding: 0px 0px 0px 30px;"|✔ Rescue/Unrescue Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Stop/Restart/Suspend/Migrate Virtual Machine
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Details And Status
+
|style="padding: 0px 0px 0px 30px;"|✔ View Interface Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Update Assigned IP Addresses
+
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Scheduled Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Scheduled Tasks
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details And Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Backup Quantity Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Restart/Suspend/Resume Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Security Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Schedule And Manage Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable Backups Routing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle VM Protection
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Usage Statistics
+
|style="padding: 0px 0px 0px 30px;"|✔ Execute Custom Scripts On Boot
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Order New IP Addresses
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Welcome Email For VM Creation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Firewall Rules
+
|style="padding: 0px 0px 10px 30px;"|✔ Run Extended Connection Test
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
+
|style="padding: 10px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Upgrade/Downgrade Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Pause/Unpause/Resume/Rebuild Server
 
|}
 
|}
−
*'''Servers Monitor - Addon Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Add/Edit Node
+
|style="padding: 0px 0px 0px 30px;"|✔ Reboot Server - Soft/Hard
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Check Nodes Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Reset Network
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Nodes Usage And Statistics
+
|style="padding: 0px 0px 0px 30px;"|✔ Rescue/Unrescue Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Virtual Machines List
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle VM Protection From WHMCS Termination And Rebuilding
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Assign And Manage IP Pools
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password For Xen Virtualization
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Requires Virtual Automation (PVA)
+
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC VNC, RDP, SPICE Or Serial Console
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports DigitalOcean Droplets  And DigitalOcean Droplets  Containers
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Restore/Delete Backups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports High Availability Function
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Add/Delete Firewall Rules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Resources Chosen During Order
+
|style="padding: 0px 0px 0px 30px;"|✔ Download Public & Private SSH Keys
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Easy IP Pools Management (Beta) [http://www.modulesgarden.com/products/whmcs/ip_manager/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Scheduled Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Volumes Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.docs.modulesgarden.com/Server_Allocator_For_WHMCS (read more)]
+
|style="padding: 0px 0px 10px 30px;"|✔ Receive Email Notification After VM Creation
 
|}
 
|}
 +
 +
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Flavor
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports DigitalOcean Droplets And DigitalOcean Droplets Containers Up To Version 7
+
|style="padding: 0px 0px 0px 30px;"|✔ VM Image
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
+
|style="padding: 0px 0px 0px 30px;"|✔ IP Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Backups Files Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
+
|style="padding: 0px 0px 0px 30px;"|✔ Disk
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure DigitalOcean Droplets  For WHMCS.''' <br />
+
|style="padding: 0px 0px 0px 30px;"|✔ RAM
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
−
==Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ VCPUs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Region
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 10px 30px;"|✔ Custom Script Files
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
+
 
|}
 
|}
 +
*'''Required Components:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ Keystone
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|style="padding: 0px 0px 0px 30px;"|✔ Glance
−
The content of PHP version files should look like this.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_2.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Nova
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install DigitalOcean Droplets For WHMCS for the first time, you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Neutron
−
File is located in '' 'modules/servers/DigitalOceanDroplets/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_3.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ Ceilometer (Required For Advanced Billing For WHMCS)
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|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 />
+
|style="padding: 10px 0px 0px 30px;"|✔ Automated Generation Of SSH Keys - Public SSH Key Is Injected To VM Automatically
−
Enter your license key between quotation marks as presented on the following screen.<br />
+
−
You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_4.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> v3.2.2 And Later - Actual Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced-billing#features (read more)]
 
|}
 
|}
−
 
−
==Activation of DigitalOcean Droplets  Monitor==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Firstly, you need to activate DigitalOcean Droplets  addon.''' <br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [http://www.modulesgarden.com/products/whmcs/server-allocator#features (read more)]
−
To do so, log in to your WHMCS and move to '' 'Setup' → 'Addon Modules'. '' Find '' 'DigitalOcean Droplets' '' and press '' 'Activate'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_5.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Cloud-Init Scripts
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_6.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports DigitalOcean Queens and Previous
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''8. In order to allow module to run smoothly, go to your addon → '' 'Installation' '' tab and add two cron jobs marked on the following screen.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports DigitalOcean Gnocchi
−
Suggested execution time for '' 'slowCron' '' - each 5 minutes.<br />
+
−
Suggested execution time for '' 'cron' '' - each minute.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_6_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
−
 
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''9. Now we will show you how to configure a new product.''' <br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
−
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_7.png]]
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Next, enter your server name, IP address, username and password. Choose '' 'DigitalOcean Droplets' '' from a dropdown menu and press '' 'Save Changes'. '''''<br />
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure DigitalOcean Droplets For WHMCS.''' <br />
−
''Note: Server you are using on WHMCS is in fact a node on your PVA server, not a whole PVA server.''
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_8.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. It is time to create a server group, to do so click on '' 'Create New Group'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_9.png]]
+
|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 the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_10.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.  
 
|}
 
|}
−
 
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure a product click on '' 'Setup' → 'Products/Services' → 'Products/Services'. '''''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_2.png]]
−
Click on '' 'Create a New Group' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_11.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install DigitalOcean Droplets For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/servers/DigitalOceanDroplets/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Enter product group name and press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_12.png]]
+
|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 />
 +
Enter your license key between quotation marks as presented on the following screen.<br />
 +
You can find your license key in our client area → '' 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can create your product. '''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_4.png]]
−
To create a product click on '' 'Create a New Product'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_13.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''6. The last step is setting up a cron job (each 5 minutes suggested).'''<br />
 +
Use cron job below but switch '' 'your_whmcs' '' with your root WHMCS path.<br />
 +
php -q /your_whmcs/modules/servers/DigitalOceanDroplets/cron/cron.php
 
|}
 
|}
 +
 +
==Configuration of Server==
 
{|
 
{|
−
|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 />
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, we will show you how to configure a new product.'''<br />
−
''Note: 'Product Type' should be set to 'Dedicated/VPS Server'.''
+
Go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, go to '' 'Module Settings' '' section, choose both '' 'DigitalOcean Droplets' '' module name and your previously created server group from a dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name and connection details.<br/>
−
Next, click on '' 'Save Changes'. '''''
+
*Provide your IP address/hostname with or without the endpoint name (you can find it in the DigitalOcean '' 'Authentication URL' '' field). <br/>
 +
*Do not forget to select which API version you want tu use ('' 'Default', 'V2' '' or '' 'V3' '').<br>
 +
*Next, specify the details of your server. Choose '' 'DigitalOceanDroplets' '' from the '' 'Type' '' dropdown menu and provide the '' 'Username', 'Password' '' and admin '' 'Tenant ID.' ''<br />'' '''Note:''' To find your ''' 'Tenant ID' ''', log in to your DigitalOcean panel and go to the 'Indentity' → 'Projects' menu. <br />Now you will need to identify the row which corresponds to your project. The 'Tenant ID' will be located in the 'Project ID' column of the identified project.''<br/>
 +
*Optionally, enter your DigitalOcean custom domain or leave this field as '' 'Default' ''.<br/>
 +
*If your DigitalOcean uses https or any custom port, you can additionally provide the revelant configuration in '' 'Secure' '' and '' 'Port'' ' fields.<br/>
 +
Finally, press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''18. From dropdown menus choose '' 'Base Node', 'Type', 'Public Network' '' and '' 'Private Network'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''9. After you have configured your server correctly, you can check the connection with the DigitalOcean server.'''<br />
−
''Note: 'DigitalOcean Droplets Container' server type can have only one routed network.''
+
Simply edit the previously created server and press '' 'Test Connection' '' as shown on the screen below.<br />
 +
During the test, connection with all related endpoints will be checked.<br/>
 +
Additionally you can change the endpoint addresses to make sure that all services have been connected successfully or select '' 'Don't use' '' if no endpoint is applicable to your DigitalOcean.<br/>
 +
'' '''Note:''' Any chosen endpoint address will be automatically saved after its selection so there is no need to save it manually after each change introduced.''
 +
<br/>
 +
 
 +
For more information about connections, visit the [http://www.docs.modulesgarden.com/DigitalOcean_VPS_For_WHMCS#Common_Problems Common Problems] and [https://www.docs.modulesgarden.com/DigitalOcean_VPS_For_WHMCS#Tips Tips] sections.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. Depending on the server type that you have chosen, you may see different field names in '' 'Default Values' '' and '' 'Configurable Options' '' subsection.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''10. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.'''
−
On the following screen we will show you the configuration of '' 'Virtual Machine' '' server type.<br />
+
−
If you wish to offer predefined servers to your clients, set up '' 'Default Values' '' and skip '' 'Configurable Options'. ''<br />
+
−
In order to set up '' 'Default Values',  '' choose '' 'Base Template' '' from a dropdown menu.<br />
+
−
Next, enter values into textboxes marked on the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. At '' 'Configurable Options' '' you can generate/update specific configurable options for product.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes' ''.'''
−
Firstly, mark/unmark checkboxes at '' 'Settings to Generate' '' to specify which option you want to generate in your configurable options.<br />
+
−
Afterwards, select nodes and base templates to generate in configurable options.<br />
+
−
At the end, confirm it through '' 'Generate Configurable Options' ''/'' 'Update Configurable Options'. ''<br />
+
−
''Note: Values which will not be generated in configurable options, will be taken from 'Default Values'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_9.png]]
 
|}
 
|}
 +
 +
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. Now, it is time to define pages and functionalities visible for client in '' 'Client Area Configuration' '' subsection.<br />
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product, go to the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
−
You can do it by simply selecting/unselecting checkboxes next to a page/functionality you want to enable/disable.<br />
+
Click on '' 'Create a New Group' ''.
−
On screen below you can see enabled all pages and functionalities.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Congratulations! You have just finished the installation and configuration of the module.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''13. Enter product group name and press '' 'Save Changes' ''.'''
−
Your clients should see something similar to the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_11.png]]
 
|}
 
|}
−
 
−
=Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 0px;"|'''DigitalOcean Droplets  For WHMCS allows your customers to manage their DigitalOcean Droplets accounts from the client area in your WHMCS system.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product.'''<br />
−
You can monitor and manage each product from your WHMCS admin area.
+
To create a product click on '' 'Create a New Product' ''.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_12.png]]
 
|}
 
|}
−
==Management of Addon==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In '' 'Addons' '' → '' 'DigitalOcean Droplets' '' you can find all used virtual machines and nodes as well as instructions on how to install the module.
+
|style="padding: 0px 0px 15px 15px;"|'''15. Afterward, choose your product group and type from the dropdown menus, enter your product name and press '' 'Continue'. '' '''<br />
 +
'' 'Product Type' '' should be set to '' 'Hosting Account'. ''
 
|}
 
|}
−
===Installation===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At this tab you can find instructions on how to install DigitalOcean Droplets For WHMCS and configure the product.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_13.png]]
−
You can also find here a link to DigitalOcean Droplets For WHMCS Wiki which you are currently reading.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_29_4.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to the '' 'Module Settings' '' section, choose both '' 'DigitalOceanDroplets' '' and your previously created server group from the dropdown menus.'''<br />
 +
Module should automatically save and reload settings. If not, click on '' 'Save Changes' '' manually.'''
 
|}
 
|}
−
 
−
<!--do wywalenia
 
−
===Templates Configuration===
 
 
{|
 
{|
−
|style="padding: 10px 20px 15px 15px;"|This tab does not support DigitalOcean Droplets  For WHMCS module, it was created for DigitalOcean Droplets  Virtual Datacenter For WHMCS.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_14.png]]
 
|}
 
|}
−
-->
 
−
 
−
===Servers Monitor===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To add new node, press '' '+ Add Node' '' button.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''17. Start from selecting a '' 'Default Tenant' ''.'''<br />
−
Afterwards, follow steps 9 to 21 of '' '[http://www.docs.modulesgarden.com/DigitalOcean Droplets_VPS_For_WHMCS#Configuration_of_Server Installation and Configuration]' '' instructions.
+
'' 'Check access' '' will return '' 'OK' '' if you set up permissions correctly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also view current node usage through pressing '' 'Usage' '' button, as presented on the following screen.
+
|style="padding: 0px 0px 15px 15px;"|'''18. Afterward, set up a network. Choose '' 'Fixed Network' '', '' 'Floating Network' '' and '' 'Default Number Of IP Addresses' ''.'''<br />
 +
You can set up network in two ways. You can find more information about the configuration [http://www.docs.modulesgarden.com/DigitalOcean_VPS_For_WHMCS#Network_Configuration_Cases here].<br />
 +
We will set up the network without a floating IP address as presented on the following screen.<br />
 +
Additionally, choose a quantity of IP addresses assigned to a product by typing it into '' 'Default Number Of IP Addresses' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In '' 'Usage' '' tab you can view resource usage in specific time period for node that you chose.
+
|style="padding: 0px 0px 15px 15px;"|'''19. At this step you can set up backups.'''<br />
 +
Mark the '' 'Backups Routing' '' checkbox if you want to replace oldest backup with newest one when backups file limit is reached.<br />
 +
Afterward, enter a limit of backup files into '' 'Default Backups Files Limit' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To access virtual machines list on a particular node, press on '' 'Virtual Machines' ''.
+
|style="padding: 0px 0px 15px 15px;"|'''20. Mark a security group from '' 'Use Security Groups' '' and select '' 'Console Type' ''.'''<br />
 +
If you wish to use SSH keys, leave '' 'Inject SSH Key' '' marked (virtualization has to support the '' 'Inject File' '' feature).<br />
 +
In order to use passwords for your VM, leave '' 'Password Management' '' marked (virtualization has to support the '' 'Set Admin Pass' '' feature).<br />
 +
Please make sure, that virtualization used by you supports mentioned actions.<br />
 +
Full list of supported  features can be found [https://wiki.DigitalOcean.org/wiki/HypervisorSupportMatrix here].<br />
 +
'' '''Important:''' It is recommended to leave '' 'Delete SSH Private Key' '' marked.''<br/>
 +
The following types of console can be chosen: '' 'VNC', 'RDP', 'SPICE' '' and '' 'Serial' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_17_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'' 'Virtual Machines' '' tab contains virtual machines list created on this WHMCS and node that you selected.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''21. You can also take advantage of the dedicated Volume and set it as the location of your Virtual Machine Disk''',
−
You can view here basic information about virtual servers.<br />
+
To do so, make sure to tick the ''Use Volumes'' checkbox and enter the desired number into the ''Default Volume Size'' field.<br />
−
To view more information about specific virtual machine, simply press on '' 'View' '' button.  
+
Note that once this option is enabled, your clients will no longer have access to the ''Backup'' and ''Rescue'' functions, so you may as well leave the respective fields empty.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_17_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you change your DigitalOcean Droplets  server connection details, you can update connection credentials on your WHMCS through pressing '' 'Edit' '' next to altered node.
+
|style="padding: 0px 0px 15px 15px;"|'''22. Next, select features available at the client area.'''<br />
 +
Mark the checkbox next to a feature in order to enable it.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, upgrade your connection details and confirm through pressing '' 'Save Changes'. ''
+
|style="padding: 0px 0px 15px 15px;"|'''23. In addition, you can also choose whether you want to send a welcome email after the VM has been succesfully created by cron.'''<br />
 +
This feature can prove useful if you want clients to receive the notification once their VM is ready rather than immediately after product activation.<br/>If you decide on this option, we suggest that you also set the standard WHMCS configuration of the 'Welcome Email' to 'None' in the '' 'Details' '' tab of a product.<br/>Otherwise, the customer will receive both emails - after the product has been activated and after the VM has been succesfully created on DigitalOcean.
 +
<br/><br/>
 +
Press '' 'Save Changes' '' when you are done.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_29.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_18_2.png]]
 
|}
 
|}
  
−
===IP Management===
+
===VPS With Predefined Resources===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our DigitalOcean Droplets For WHMCS module supports management of IP addresses, but it needs [https://www.modulesgarden.com/products/whmcs/ip-manager IP Manager For WHMCS] module to work correctly.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our module allows you to offer DigitalOcean Droplets to your clients in two ways, with either predefined or configurable resources.<br />
−
To access it, go to '' 'Addons' '' → '' 'DigitalOcean Droplets' '' → '' 'Servers Monitor' '' and press '' 'IP Management' '' button.
+
In this section we will show you configuration of VPS with predefined resources.<br />
 +
Detailed information about configuration of VPS with resources chosen by a client can be found [http://www.docs.modulesgarden.com/DigitalOcean_VPS_For_WHMCS#VPS_With_Configurable_Resources here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.1.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''23. Select a '' 'Default Flavor' '' and '' 'Default VM Image' ''.'''<br />
 +
'' 'Default Flavour' '' defined resources assigned to a VM while '' 'Default VM Image' '' allows you to choose the VM image used to create a new VM.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see, you can assign different IP Manager configurations to each network type.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_19.png]]
−
Let's add a new configuration to '' 'Host Only' '' network. To do so, press '' ' Create a new configuration for this network' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.2.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! You have just finished the installation and configuration of the module with predefined resources.'''
 
|}
 
|}
 +
 +
===VPS With Configurable Resources===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You will be moved to the IP Manager module where you can create a new configuration for DigitalOcean Droplets product.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''24. Preparing VPS with configurable options consists of pressing '' 'Generate default' '' as shown on the following screen.'''<br />
−
Provide your configuration name, assign it to DigitalOcean Droplets products, addons or server and press '' 'Create New Configuration' ''.
+
It will prepare default configurable options which can be afterward easily edited as described in [http://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options this article].<br />
 +
'''Important''' Configurable option '' 'flavor|Flavor' '' will be overwritten by '' 'disc|Disc' '', '' 'ram|RAM' '' and '' 'vcpus|VCPUs' ''.<br />
 +
Therefore, you can solve this in three ways:
 +
*Remove '' 'disc|Disc' '', '' 'ram|RAM' '' and '' 'vcpus|VCPUs' '' configurable option and rely completely on '' 'flavor|Flavor' ''.
 +
*Remove '' 'disc|Disc' '' and '' 'vcpus|VCPUs' '', and allow '' 'flavor|Flavor' '' being overwritten by '' 'ram|RAM' '' (multiple combinations allowed here).
 +
*Remove '' 'flavor|Flavor' '' and rely completely on '' 'disc|Disc' '', '' 'ram|RAM' '' and '' 'vcpus|VCPUs' ''.
 +
''Note: The second and the third options results in creation of a new flavor on your server each time a new order is made.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_20.png]]
 
|}
 
|}
 +
 +
===Custom Config Scripts===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now you can add IP pool through creating a new subnet.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''25. In this area, you can write a custom script using [https://raymii.org/s/tutorials/Automating_DigitalOcean_with_Cloud_init_run_a_script_on_VMs_first_boot.html Cloud-Init] and arrange it to be executed on newly created VMs.'''<br />
−
To do so, click '' 'Create New Subnet' '' button and follow the steps described [https://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Create_Subnet here].<br/>
+
This way you can automate your work instead of making all kinds of specific images for specific tasks manually. <br /><br />
−
'' '''Note:''' It is also recommended to enable IP Manager integration module for DigitalOcean Droplets. You can find instruction on how to do that [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Enabling_3rd_Party_Integration here], but you do not have to assign configuration to it.''
+
'''Important notes:'''
 +
*Scripts can be written in standards like '''Bash''' or '''[http://www.yaml.org/about.html YAML]'''.
 +
*Initial scripts have to be supported by VPS operating system to be executed properly.
 +
*Scripts should be used only by advanced users. The incorrect usage of the scripts may damage your system!
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_44.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Successfully created IP pool can now be assign to your previously set DigitalOcean Droplets configuration.<br/>
+
|style="padding: 0px 0px 15px 15px;"|On the example below, we will show an examplary script responsible for setting the password to '' 'newpass01' '' for the Ubuntu root user.<br />
−
Go back to the IP Manager configuration list and press the '' 'Assigned Subnets' '' button.
+
You can achieve it by writing:
 +
chpasswd:
 +
  list: |
 +
  ubuntu:newpass01
 +
  expire:False
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_45.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Select created IP pool from the dropdown menu and press '' 'Assign Subnet' ''.
+
|style="padding: 0px 0px 15px 15px;"|You can configure scripts in the same format, but for clients' individual choice when ordering the product.<br />
 +
All you need to do is add a new configurable option and assign it to the DigitalOcean Droplets product.<br />
 +
''Note: these scripts are executed regardless of the script specified in the module settings.''<br />
 +
The easiest way is through the edition of existing 'Configurable options for the DigitalOcean Droplets' group, and adding the new configurable option there.<br />
 +
For example, if you want to offer the pre-installed PHP version depending on a client's choice, you can add a new option named '''script_PHP|PHP version''' and then define multiple options, like on the screenshot below:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_46.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once again move to the configuration list.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Afterward, your clients can choose during the ordering process:
−
You will now have to assign DigitalOcean Droplets configurable options that will be used to determine the number of IP addresses from the pool assigned to the DigitalOcean Droplets product.<br/>
+
−
'' '''Note:''' The configurable options are '''required''' for IP addresses assignment by IP Manager.''<br/>
+
−
Even if you do not want to use all configurable options for the product, you have to create and assign at least these two:
+
−
ip_number|Number of Public IP
+
−
ip_number_secondary|Number of Private IP
+
−
Click [https://www.docs.modulesgarden.com/DigitalOcean Droplets_VPS_For_WHMCS#Editing_Configurable_Options here] for more information. If you already have configurable options set, press the '' 'Configurable Options' '' button to add a new relation.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_47.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now you can add the defined DigitalOcean Droplets configurable option relations to your IP Manager.<br/>Specify what type of address to assign to the chosen'' 'Network ID' '': public IP, private IP or both as a shared address.<br/>
+
|style="padding: 0px 0px 30px 15px;"|
−
'' '''Important:''' If you decide to assign both public and private configurable options, as shown below, then you will also '''have to''' assign that configuration for the second network interface (if used).
+
Using this method, you can perform assorted actions on newly created machines, e.g.: modifying files, preinstalling & preconfiguring software, executing any statements that would normally be executed via the terminal.<br /><br />
 +
The general rule is that configurable option names should begin with '''script_prefix''' to be recognized as containing a custom script.<br />
 +
Then, choices under the option have their own names which are matched with a name of existing file with the corresponding script under the
 +
'''yourWHMCS/modules/servers/DigitalOceanDroplets/scripts''' path.<br />
 +
Note that files with scripts have to have '''exactly''' extension corresponding to the given entries in the configurable options.<br /><br />
 +
In the example above, there are two options: '''php5.yml''' and '''php7.yml''', therefore it makes the module read corresponding files:<br />
 +
*modules/servers/DigitalOceanDroplets/scripts/php5.yml
 +
or
 +
*modules/servers/DigitalOceanDroplets/scripts/php7.yml
 +
You can add many scripts in the exact way.
 
|}
 
|}
 +
 +
=Management=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.8.png]]
+
|style="padding: 10px 0px 15px 15px;"|''' DigitalOcean Droplets For WHMCS allows your customers to manage their DigitalOcean Droplets via the client area in your WHMCS system.'''<br />
 +
You can monitor and manage each product from your WHMCS admin area.<br />
 +
1. Configurable options which enables you to view current VPS resources and change VPS specifications through changing configurable options and pressing '' 'Change Package' ''.<br />
 +
2. Module commands enables you to manage VPS status.<br />
 +
3. Here you can find VPS details and refresh them through pressing the '' 'Refresh Details' '' icon.<br />
 +
4. Scheduled tasks status can be found in this table.<br />
 +
5. In marked custom fields you can find IDs of VM and private flavor.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Finally, go back to the DigitalOcean Droplets addon and assign the created configuration to the chosen network interface.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_24.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.8.png]]
+
|style="padding: 0px 0px 20px 15px;"|If you decided to select the ''Use Volumes'' feature, you will see an additional section named ''Volumes''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Congratulations, you have successfully completed the IP Manager configuration!<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_24_1.png]]
−
Repeat the above steps for the second configuration in the same manner, or use the already created configuration to use shared IP pool.
+
 
|}
 
|}
−
 
+
==Ordering==
−
==Management of Admin Area==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At the admin area you can order basic options(2) as '' 'Create' '', '' 'Suspend' '', '' 'Unsuspend' '', '' 'Terminate' '' and '' 'Change Package' ''.<br />
+
|style="padding: 10px 0px 15px 15px;"|Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.<br />
−
You can also order '' 'Server Actions' ''(3) such as '' 'Stop' '', '' 'Restart' '', '' 'Suspend' '', '' 'Start' '', '' 'Reinstall' '', '' 'Resume' '' and '' 'Migrate' ''.<br />
+
Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.<br />
−
You are able to configurable options(1), server details(4), assigned IP addresses(5), scheduled cron tasks(6) and host ID(7).<br />
+
'''Important: VPS is not created immediately after ordering '' 'Create' ''. Therefore, it is wise to inform your clients about the delay.'''
−
''Note: 'Basic Template' cannot be changed if product was already created. 'Node' can be changed only using 'Migrate' and 'OS Template' through using 'Reinstall'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_25.png]]
 
|}
 
|}
−
===Reinstall===
+
 
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|To reinstall your virtual server you have to stop it through pressing '' 'Stop' '' button.
+
|style="padding: 10px 0px 15px 15px;"|Client area interface of DigitalOcean Droplets should look like the one on the screen below. As you can see, the control panel contains useful options needed for managing a VPS.<br />
−
''Note: You are not able to reinstall 'Virtual Machine' server type.''
+
Module allows your customers to easily start/stop, pause/unpause, resume, soft reboot, hard reboot and reset network of their servers through pressing the specific button.<br />
 +
Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.<br />
 +
At '' 'Tasks' '' your customers can view all requested tasks that was not yet completed.<br />
 +
Each task has additional information bounded to them, like a type of task, attempts to perform tasks or a last returned response.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_26.png]]
 
|}
 
|}
 +
===Volumes===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, press '' 'Reinstall' '' button.
+
|style="padding: 10px 0px 15px 15px;"|In case your DigitalOcean Droplets is running with the ''Use Volumes'' option, the client area may look a bit different. It will now include an additional section named ''Volumes''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_26_1.png]]
 
|}
 
|}
  
−
===Migrate===
+
===Rebuild===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To migrate your virtual machine, choose server you want to migrate your virtual machine to.<br />
+
|style="padding: 10px 0px 15px 15px;"|The rebuild feature allows your clients to change a server image.<br />
−
Afterwards, select node on this server from a '' 'Node' '' configurable option and press '' 'Save Changes' '' button.<br />
+
Press the '' 'Rebuild' '' button as shown on the following screen in order to move to the rebuild page.
−
The last step is pressing '' 'Migrate Button' ''.<br />
+
−
''Note: To migrate your virtual server you have to generate 'Node' configurable option.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_27.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Next, press '' 'Migrate' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_34.png]]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, popup should appear. Confirm migration through clicking '' 'Migrate' '' button.
+
|style="padding: 0px 0px 20px 15px;"|To reinstall your server, choose an image and confirm through clicking on '' 'Rebuild' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_28.png]]
 
|}
 
|}
  
−
==Management of Client Area==
+
===Rescue Mode===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Client area interface of DigitalOcean Droplets  should look like the one on the screen below.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The rescue mode provides a mechanism for a VM access even in case the VM's image renders the instance inaccessible - e.g. if instance's filesystem becomes corrupted. <br />
−
As you can see, control panel contains useful options needed to manage a VPS.<br/>
+
The rescue VM will be launched to permit the user to fix their VM.
−
Module allows your customers to easily '' 'Suspend' ''(1), '' 'Stop' ''(2), '' 'Restart' ''(3) their servers through pressing a specific button.<br/>
+
−
It is also available to '' 'Start' '', '' 'Reinstall' '' (4) and '' 'Resume' '' server by clicking on defined buttons.<br/>
+
−
'' 'Start' '' and '' 'Reinstall' '' actions are available only when server is down, '' 'Resume' '' is available when server is suspended.<br/>
+
−
Clients can also create backup and set up backup jobs(5), access VNC console(7), view virtual server usage statistics(6) and manage IP addresses(8).<br/>
+
−
''' ''Note: If your client is using 'DigitalOcean Droplets  Container' they can also manage firewall'' ''' (9).
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_36.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_48.png]]
 
|}
 
|}
−
===Backups Management===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Backups Management' ''(5) you can order backup jobs or create backups.<br/>
+
|style="padding: 0px 0px 20px 15px;"|
−
To create backup job press '' 'Create Backup Schedule' '' as shown on the screen below.
+
Before you continue please note that the rescue VM will be set up with the same network configuration as the real VM. <br />
−
''Note: If two backup task are ordered in too small time interval, only one backup is created.''
+
Moreover, a new root password will be generated and the VM status will change to 'RESCUE'.<br />
 +
The new VM will also have a rescue image as the primary filesystem and the secondary filesystem would be the original VM's primary filesystem.'' <br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_37.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_49.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now define backup description by typing its name into a textbox and choose backup type from a dropdown menu.<br/>
+
|style="padding: 0px 0px 20px 15px;"|When you want to disable the rescue mode, click the 'Unrescue' buton. TheVM status will then also return to 'ACTIVE'.
−
You can choose whether to delete previous backup or not, through marking  checkbox next to '' 'Remove Previous'. ''<br/>
+
−
Afterwards, select '' 'Recurrence Pattern' '' through marking desired option and set time of run.<br/>
+
−
On the screen below you can view sample setting for '' 'Repeat Daily' '' option.<br/>
+
−
To create this backup job, press '' 'Create Backup Schedule' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_38.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_50.png]]
 
|}
 
|}
 +
 +
===Backups===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also create a single backup. To do so, click on '' 'Create Backup' '' button as shown on the following screen.
+
|style="padding: 10px 0px 20px 15px;"|Your customers can also create a backup of VPS. To do so, press the '' 'Backups' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_39.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now enter backup description and select backup type from a dropdown menu.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Now, choose a backup name and click '' 'Backup Now' ''.
−
Afterwards, choose whether to delete previous backup or not, through marking  checkbox next to '' 'Remove Previous'. ''<br/>
+
−
Confirm creation of this backup through pressing '' 'Create Backup' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_40.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_32.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To restore Virtual Machine from the backup, simply press restore icon and '' 'Restore' '' button.
+
|style="padding: 0px 0px 15px 15px;"|To restore a VPS from backup, simply press the '' 'Restore' '' button next to it.<br />
 +
As you may notice on the following screen, presented earlier the '' 'First Backup' '' backup was replaced with the '' 'New Backup' ''.<br />
 +
It was caused by a backup routing feature which was triggered by reaching the backups file limit.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_41.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_33.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|At the top of this page, your client can view current backup usage and backup limit.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_42.png]]
+
 
|}
 
|}
  
−
===Console===
+
===noVNC Console===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionalities is noVNC console(7) (which uses HTML5) where your clients can remotely manage server.<br/> To access it, simply press on the '' 'Console' '' button. A new window will be opened, so make sure your browser does not block it.<br/>
+
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is a noVNC console where your clients can remotely manage their server.<br />  
−
'' '''Note:''' If the noVNC console does not work, make sure that it was enabled in your DigitalOcean Droplets panel. There you can also test if it works properly.  
+
To access it, simply click on the '' 'Console' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_43.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_29.png]]
 
|}
 
|}
−
 
−
===Firewall Management===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under '' 'Firewall Management' '' (9) section the client can set up firewall for their virtual server.<br/>
+
|style="padding: 0px 0px 20px 15px;"|noVNC is a browser based VNC client. It was implemented using HTML5 Canvas and WebSockets.
−
They can '' 'Enable' ''/'' 'Disable' '' firewall(1), add new firewall rules(2), view existing rules list and manage existing rules(3).<br/>
+
−
''' ''Note: 'Firewall Management' is available only for 'DigitalOcean Droplets  Container' server type.'' '''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_44.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_30.png]]
 
|}
 
|}
  
−
===Usage Statistics===
+
===VM Protection===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At '' 'Usage Statistics' '' your client can view  information about resource used by his virtual server.<br/>
+
|style="padding: 10px 0px 20px 15px;"|In the product configuration page you can enable the '' 'Protect VM After Creation' '' option which prevents the termination or rebuilt of VM.<br/>
−
He can find resource usage and graphs of CPU, memory, bandwidth and disk.<br/>
+
The selected status of this protection will be applied to both admin area and client area.
−
Additionally, he can choose period of resource usage to display on graphs.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_45.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_51.png]]
 
|}
 
|}
−
===IP Management===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Here your client can find all IP addresses assigned to their virtual server.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Moreover, if the '' 'Protect VM' '' option is enabled in the client area, the client will be empowered to toggle the current protection status.
−
They can also order new IP addresses.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_46.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_52.png]]
 
|}
 
|}
 +
===Firewall===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|To order new IP addresses, press '' 'Order New IP'. ''<br/>
+
|style="padding: 10px 0px 15px 15px;"|The firewall management page allows your customers to view, add or delete existing rules on a security group assigned to the product.<br/>
−
''Note 1: To order a new IP you have to generate configurable options for 'Number of Public IP' and 'Number of Private IP'.''<br/>
+
To add a new firewall rule, use the button marked on the following screen.  
−
''Depending on generated configurable options, your client will be able to order public IP, private IP or both.''<br/>
+
−
''Note 2: You can hide these configurable options from the order form. You can find instruction [http://www.docs.modulesgarden.com/Parallels_Cloud_Server#Hiding_Configurable_Options here].
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_47.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_53.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Popup will appear, select IP address type and press '' 'Order'. ''
+
|style="padding: 0px 0px 15px 15px;"|Next, choose the rule type (TCP or UDP), direction (inbound or outbound) and ether type (IPv4 or IPv6).<br/>Depending on the port you choose, you will be able to add a rule for a single port only, a range of ports or all ports at once. You can also select one of the predefined ports or use a custom one.<br/>Finally, provide a single IP address or specify the range of addresses using the CIDR format (e.g. 10.10.10.1/24) and add rule description if you wish.<br/>
 +
Press '' 'Add' '' when ready.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_48.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_54.png]]
 
|}
 
|}
  
−
==Management of Configurable Options==
+
==Network Configuration Cases==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your client can order it by choosing amount of resources from default configurable options.
+
|style="padding: 10px 0px 15px 15px;"|DigitalOcean Droplets For WHMCS allows you to set up two types of network.<br />
 +
The first one is a network without a floating IP address.<br />
 +
To set up this type of network, choose '' 'Public' '' as '' 'Fixed Network' '' and '' 'Disabled' '' as '' 'Floating Network' ''.<br />
 +
On the following screen you can view an exemplary topology of such network.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_49.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_36.png]]
 
|}
 
|}
−
===Editing Configurable Options===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In case these options don't suit your needs, you can edit them.<br/>
+
|style="padding: 0px 0px 15px 15px;"|The second type of network is the network with a floating IP address.<br />
−
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' ''.<br/>
+
Select '' 'Shared Network' '' as '' 'Fixed Network' '' and '' 'Public' '' as '' 'Floating Network' ''.
−
Afterwards, press edit button next to configurable option used by your product (its name is '' 'Configurable options for your_product_name' '').
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_50.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_37.png]]
 
|}
 
|}
 +
 +
==Configurable Options==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can view all products this configurable option group is assigned to.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In case that standard configuration is not fitting your needs, you can adjust it through configurable options.<br />
−
Now, let us show you how to edit options. Lets say you want to add an option to order VPS with 1000 GB disk.<br/>
+
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option' '' and press the edit button next to a configurable option used by your product.<br />
−
To do so, edit '' 'hddSize_gb|Disk Size in GB' '' by pressing edit button as shown on the screen below.
+
Its name is '' 'Configurable options for your_product_name' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_51.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_38.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You will see a popup window, so make sure your browser will not block it.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Here you can view the products that this configurable option group is assigned to.<br />
−
Edit '' 'Maximum Allowed' '' textbox as shown on the following screen.<br/>
+
Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 8GB (8192 MB) RAM.<br />
−
Afterwards, press '' 'Save Changes'. ''
+
To do so, edit '' 'ram|RAM' '' by pressing the edit button as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_52.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_39.png]]
−
|}
+
−
 
+
−
===Hiding Configurable Options===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|If you decide to  hide configurable options from a client order form, follow steps below.<br />
+
−
Firstly, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Option'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_53.png]]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Afterwards, tick '' 'Hidden' '' checkboxes next to configurable options you want to hide.<br />
+
|style="padding: 0px 0px 15px 15px;"|You will see a popup window, so make sure that your browser will not block it.<br />
−
On the screen below you can see hiding of '' 'Number of Public IP' '' and '' 'Number of Private IP'. ''
+
To add a new option, enter it in a textbox under all other options. If you want to replace it with an option you currently have, simply edit its text box.<br />
 +
Next, press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_54.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_40.png]]
 
|}
 
|}
  
 
==Management of Billing==
 
==Management of Billing==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When you combine DigitalOcean Droplets For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br/>
+
|style="padding: 10px 0px 15px 15px;"|When you combine DigitalOcean Droplets 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 based on the server resources used by them.<br/>
+
Module allows you to charge your customers based on the server resources used by them.<br />
−
''Note: To set price for specific template you need to have it assigned to product configurable options.''
+
''Note: Advanced Billing currently supports only API prior V3 (DigitalOcean Ocata). A new compatibility will be added soon.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_55.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_42.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage, their cost, usage history and charts.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_56.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_43.png]]
 
|}
 
|}
  
−
==Management of Existing Accounts==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''You can easily use DigitalOcean Droplets  For WHMCS module with your existing DigitalOcean Droplets accounts. To do so, follow the instructions below:'''<br />
+
|style="padding: 10px 0px 5px 15px;"|1. Due to some requests may take time to be completed, we implemented '' 'Scheduled Tasks' ''.<br />
−
1. Create and configure a DigitalOcean Droplets  server and a server group.<br />
+
Tasks visible at '' 'Scheduled Tasks' '' are subsequently performed by a cron job.<br />
−
2. Create and configure a DigitalOcean Droplets  product. '''Product configuration should be the same as virtual machine you want to connect to DigitalOcean Droplets  module.'''<br />
+
Full list of tasks supported by '' 'Scheduled Tasks' '' are: create, terminate, change package, remove IP address and remove backup.
−
3. Place new order with previously created product for your customer (it is important to use same hostname as VM you want to use). '''Do not activate product yet.'''<br />
+
−
4. Go to '' 'Products/Services' '' section of freshly created product and press '' 'Assign VM by Name' '', this will only connect VM by UUID, and get IP addresses list.<br />
+
−
6. Set product status to '' 'Active' ''.<br /><br />
+
−
'''Remember to not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''<br /><br />
+
−
If you decide to remove VM and you do not want to configure it on WHMCS system, create product with its hostname and use '' 'Delete VM by Name' ''.<br />
+
−
'''Use '' 'Delete VM by Name' '' button with care.<br />
+
−
Both  '' 'Assign VM by Name' '' and '' 'Delete VM by Name' '' can be found in admin area of uncreated DigitalOcean Droplets  product.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|[[File:DOD_56.1.png]]
+
|style="padding: 0px 0px 5px 15px;"|2. '''Important:''' module has to use admin endpoints instead of public endpoints.<br />
−
|}
+
In properly configured DigitalOcean server, wget from WHMCS server should be able to get any data from any '''admin''' endpoint.<br />
 +
Sample successfull requests:
 +
wget DigitalOcean:9292
 +
--2014-03-31 09:35:24-- http://DigitalOcean:9292/
 +
Resolving DigitalOcean(DigitalOcean)... 192.168.1.222
 +
Connecting to DigitalOcean(DigitalOcean)|192.168.1.222|:9292... connected.
 +
HTTP request sent, awaiting response... 300 Multiple Choices
 +
Length: 520 [application/json]
 +
Saving to: `index.html'
 +
 +
100%[==========================================================>] 520 --.-K/s in 0s
 +
 +
2014-03-31 09:35:24 (118 MB/s) - `index.html' saved [520/520]
 +
 
  
−
=Tips=
+
wget DigitalOcean:8777
−
{|
+
--2014-03-31 09:41:05-- http://DigitalOcean:8777/
−
|style="padding: 10px 0px 5px 15px;"|1. Operations performed on the virtual servers are not executed immediately.<br />
+
  Resolving DigitalOcean(DigitalOcean)... 192.168.1.222
−
Give your DigitalOcean Droplets servers some time for processing the request and execution of operation.  
+
Connecting to DigitalOcean(DigitalOcean)|192.168.1.222|:8777... connected.
−
|}
+
HTTP request sent, awaiting response... 401 Unauthorized
−
{|
+
Authorization failed.  
−
|style="padding: 0px 0px 10px 15px;"|2. To change password, OS on VM has to finish a boot sequence. Password is changed when ready status is detected by cron.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 5px 15px;"|3. You can also check if your server connection is configured correctly.<br />
+
−
Go to '' 'Setup' '' → '' 'Product/Services' '' → '' 'Servers' '' and press '' 'Test Connection' '' button next to your server.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOD_56_2.png]]
+
|style="padding: 0px 0px 30px 15px;"|3. A primary IP address is always assigned by DigitalOcean server when a VM is created Therefore, if you decide to order 2 IP addresses, then 3 addresses will be assigned.<br> The primary one and the two additionally ordered. If you wish only one IP address to be assigned to a single product, please set the filed '' 'Default Number Of IP Addresses' '' to '0'<br/> or leave it empty in the product's '' 'Module Settings'. ''
 
|}
 
|}
  
Line 702: Line 703:
 
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/>
 
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/>
 
|}
 
|}
−
==How To Update==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|1. If you switch from Parallels Cloud Server to newer version of DigitalOcean Droplets, follow the below steps.<br/>
 
−
Firstly, download the latest version from your client area.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|2. In the downloaded file you will find two packages that support different PHP versions.<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3.7 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
 
−
'' Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOD_2_1_1.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 20px 25px;"|[[File:DOD_2_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|4. Then you need to update server settings in '' 'Products/Services' → 'Servers'. '' Find more [https://www.docs.modulesgarden.com/DigitalOcean Droplets_VPS_For_WHMCS#Configuration_of_Server here]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|5. Finally, update your product details. To do so, move to '' 'Products/Services' → 'Products/Services'. '' Find details [https://www.docs.modulesgarden.com/DigitalOcean Droplets_VPS_For_WHMCS#Configuration_of_Product here.]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|6. If you are updating from Parallels Cloud Server 1.0.5 or older, you have to make additional changes.<br />
 
−
Update configurable options of product using DigitalOcean Droplets  module.<br />
 
−
Update ordered product using DigitalOcean Droplets  module.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|'''Your module and products have been just successfully updated, good job!'''
 
−
|}
 
−
 
 
=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 20px 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. It can happen that at your '' 'Module Settings' '' tab you can get loading gray screen.<br/>
+
−
Do not worry, it can take a while to download available settings from your PVA server.<br/>
+
−
But if loading takes too long, check if your server connection credential is set correctly.<br/>
+
−
Remember, use connection credential to PVA server node, not PVA server itself.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|3. When you see message shown on the screen below, it means that you have not installed IP Manager For WHMCS.<br/>
+
−
This module is needed to manage your IP addresses from DigitalOcean Droplets  addon, and can be downloaded from [https://www.modulesgarden.com/products/whmcs/ip-manager here].
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 25px 25px;"|[[File:DOD_57.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|'''4. It is not advised to use Parallels Cloud Server For WHMCS module with DigitalOcean Droplets  For WHMCS at the same time.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|5. If you are getting an error like this one:
+
|style="padding: 0px 0px 30px 15px;"|2. In case of persisting connection problems, please make sure you have the following ports open:
−
  SQLSTATE[42S02]: Base table or view not found: 1146 Table 'username.pcsNetworkClassConf' doesn't exist.
+
  8774, 35357, 9292, 5000, 8777, 9696, 8776
−
when configuring product's module settings, make sure that the DigitalOcean Droplets addon has been enabled.
+
 
|}
 
|}

Revision as of 11:29, 22 June 2018

Contents

About DigitalOcean Droplets For WHMCS

DigitalOcean Droplets For WHMCS XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Change Package - Supports Configurable Options
✔ Change Password - Xen Virtualization Only
✔ Rescue/Unrescue Server
✔ View Server Status And Details
✔ View Interface Details
✔ View List Of Scheduled Tasks
✔ Configure Client Area Features Per Product
✔ Define Backup Quantity Limit
✔ Set Security Groups
✔ Enable Backups Routing
✔ Toggle VM Protection
✔ Execute Custom Scripts On Boot
✔ Choose Welcome Email For VM Creation
✔ Run Extended Connection Test
  • Client Area Features:
✔ View Server Status And Details
✔ Start/Stop/Pause/Unpause/Resume/Rebuild Server
✔ Reboot Server - Soft/Hard
✔ Reset Network
✔ Rescue/Unrescue Server
✔ Toggle VM Protection From WHMCS Termination And Rebuilding
✔ Change Password For Xen Virtualization
✔ Access noVNC VNC, RDP, SPICE Or Serial Console
✔ Create/Restore/Delete Backups
✔ View/Add/Delete Firewall Rules
✔ Download Public & Private SSH Keys
✔ View List Of Scheduled Tasks
✔ View Volumes Information
✔ Receive Email Notification After VM Creation
  • Configurable Options:
✔ Flavor
✔ VM Image
✔ IP Addresses
✔ Backups Files Limit
✔ Disk
✔ RAM
✔ VCPUs
✔ Region
✔ Custom Script Files
  • Required Components:
✔ Keystone
✔ Glance
✔ Nova
✔ Neutron
✔ Ceilometer (Required For Advanced Billing For WHMCS)
  • General Info:
✔ Automated Generation Of SSH Keys - Public SSH Key Is Injected To VM Automatically
✔ 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 Cloud-Init Scripts
✔ Supports DigitalOcean Queens and Previous
✔ Supports DigitalOcean Gnocchi
✔ 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 DigitalOcean Droplets 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.
DOD 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

DOD 2.png
4. When you install DigitalOcean Droplets For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/DigitalOceanDroplets/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

DOD 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen.
You can find your license key in our client area → 'My Products' .

DOD 4.png
6. The last step is setting up a cron job (each 5 minutes suggested).

Use cron job below but switch 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/DigitalOceanDroplets/cron/cron.php

Configuration of Server

7. Now, we will show you how to configure a new product.

Go to the 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' .

DOD 5.png
8. Next, enter your server name and connection details.
  • Provide your IP address/hostname with or without the endpoint name (you can find it in the DigitalOcean 'Authentication URL' field).
  • Do not forget to select which API version you want tu use ( 'Default', 'V2' or 'V3' ).
  • Next, specify the details of your server. Choose 'DigitalOceanDroplets' from the 'Type' dropdown menu and provide the 'Username', 'Password' and admin 'Tenant ID.'
    Note: To find your 'Tenant ID' , log in to your DigitalOcean panel and go to the 'Indentity' → 'Projects' menu.
    Now you will need to identify the row which corresponds to your project. The 'Tenant ID' will be located in the 'Project ID' column of the identified project.
  • Optionally, enter your DigitalOcean custom domain or leave this field as 'Default' .
  • If your DigitalOcean uses https or any custom port, you can additionally provide the revelant configuration in 'Secure' and 'Port ' fields.

Finally, press 'Save Changes' .

DOD 6.png
9. After you have configured your server correctly, you can check the connection with the DigitalOcean server.

Simply edit the previously created server and press 'Test Connection' as shown on the screen below.
During the test, connection with all related endpoints will be checked.
Additionally you can change the endpoint addresses to make sure that all services have been connected successfully or select 'Don't use' if no endpoint is applicable to your DigitalOcean.
Note: Any chosen endpoint address will be automatically saved after its selection so there is no need to save it manually after each change introduced.

For more information about connections, visit the Common Problems and Tips sections.

File:DOD 7.png
10. It is time to create a server group. To do so, click on 'Create Server Group' .
DOD 8.png
11. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes' .
DOD 9.png

Configuration of Product

12. In order to create and configure a product, go to the 'Setup' → 'Products/Services' → 'Products/Services' .

Click on 'Create a New Group' .

DOD 10.png
13. Enter product group name and press 'Save Changes' .
DOD 11.png
14. When you have a product group, you can create your product.

To create a product click on 'Create a New Product' .

DOD 12.png
15. Afterward, choose your product group and type from the dropdown menus, enter your product name and press 'Continue'.

'Product Type' should be set to 'Hosting Account'.

DOD 13.png
16. Now, go to the 'Module Settings' section, choose both 'DigitalOceanDroplets' and your previously created server group from the dropdown menus.

Module should automatically save and reload settings. If not, click on 'Save Changes' manually.

DOD 14.png
17. Start from selecting a 'Default Tenant' .

'Check access' will return 'OK' if you set up permissions correctly.

DOD 15.png
18. Afterward, set up a network. Choose 'Fixed Network' , 'Floating Network' and 'Default Number Of IP Addresses' .

You can set up network in two ways. You can find more information about the configuration here.
We will set up the network without a floating IP address as presented on the following screen.
Additionally, choose a quantity of IP addresses assigned to a product by typing it into 'Default Number Of IP Addresses' .

DOD 16.png
19. At this step you can set up backups.

Mark the 'Backups Routing' checkbox if you want to replace oldest backup with newest one when backups file limit is reached.
Afterward, enter a limit of backup files into 'Default Backups Files Limit' .

DOD 17.png
20. Mark a security group from 'Use Security Groups' and select 'Console Type' .

If you wish to use SSH keys, leave 'Inject SSH Key' marked (virtualization has to support the 'Inject File' feature).
In order to use passwords for your VM, leave 'Password Management' marked (virtualization has to support the 'Set Admin Pass' feature).
Please make sure, that virtualization used by you supports mentioned actions.
Full list of supported features can be found here.
Important: It is recommended to leave 'Delete SSH Private Key' marked.
The following types of console can be chosen: 'VNC', 'RDP', 'SPICE' and 'Serial' .

DOD 17 1.png
21. You can also take advantage of the dedicated Volume and set it as the location of your Virtual Machine Disk,

To do so, make sure to tick the Use Volumes checkbox and enter the desired number into the Default Volume Size field.
Note that once this option is enabled, your clients will no longer have access to the Backup and Rescue functions, so you may as well leave the respective fields empty.

File:DOD 17 2.png
22. Next, select features available at the client area.

Mark the checkbox next to a feature in order to enable it.

DOD 18.png
23. In addition, you can also choose whether you want to send a welcome email after the VM has been succesfully created by cron.

This feature can prove useful if you want clients to receive the notification once their VM is ready rather than immediately after product activation.
If you decide on this option, we suggest that you also set the standard WHMCS configuration of the 'Welcome Email' to 'None' in the 'Details' tab of a product.
Otherwise, the customer will receive both emails - after the product has been activated and after the VM has been succesfully created on DigitalOcean.

Press 'Save Changes' when you are done.

DOD 18 2.png

VPS With Predefined Resources

Our module allows you to offer DigitalOcean Droplets to your clients in two ways, with either predefined or configurable resources.

In this section we will show you configuration of VPS with predefined resources.
Detailed information about configuration of VPS with resources chosen by a client can be found here.

23. Select a 'Default Flavor' and 'Default VM Image' .

'Default Flavour' defined resources assigned to a VM while 'Default VM Image' allows you to choose the VM image used to create a new VM.

DOD 19.png
Congratulations! You have just finished the installation and configuration of the module with predefined resources.

VPS With Configurable Resources

24. Preparing VPS with configurable options consists of pressing 'Generate default' as shown on the following screen.

It will prepare default configurable options which can be afterward easily edited as described in this article.
Important Configurable option 'flavor|Flavor' will be overwritten by 'disc|Disc' , 'ram|RAM' and 'vcpus|VCPUs' .
Therefore, you can solve this in three ways:

  • Remove 'disc|Disc' , 'ram|RAM' and 'vcpus|VCPUs' configurable option and rely completely on 'flavor|Flavor' .
  • Remove 'disc|Disc' and 'vcpus|VCPUs' , and allow 'flavor|Flavor' being overwritten by 'ram|RAM' (multiple combinations allowed here).
  • Remove 'flavor|Flavor' and rely completely on 'disc|Disc' , 'ram|RAM' and 'vcpus|VCPUs' .

Note: The second and the third options results in creation of a new flavor on your server each time a new order is made.

DOD 20.png

Custom Config Scripts

25. In this area, you can write a custom script using Cloud-Init and arrange it to be executed on newly created VMs.

This way you can automate your work instead of making all kinds of specific images for specific tasks manually.

Important notes:

  • Scripts can be written in standards like Bash or YAML.
  • Initial scripts have to be supported by VPS operating system to be executed properly.
  • Scripts should be used only by advanced users. The incorrect usage of the scripts may damage your system!
File:DOD 44.png
On the example below, we will show an examplary script responsible for setting the password to 'newpass01' for the Ubuntu root user.

You can achieve it by writing: 

chpasswd:
 list: |
 ubuntu:newpass01
 expire:False
File:DOD 45.png
You can configure scripts in the same format, but for clients' individual choice when ordering the product.

All you need to do is add a new configurable option and assign it to the DigitalOcean Droplets product.
Note: these scripts are executed regardless of the script specified in the module settings.
The easiest way is through the edition of existing 'Configurable options for the DigitalOcean Droplets' group, and adding the new configurable option there.
For example, if you want to offer the pre-installed PHP version depending on a client's choice, you can add a new option named script_PHP|PHP version and then define multiple options, like on the screenshot below:

File:DOD 46.png
Afterward, your clients can choose during the ordering process:
File:DOD 47.png

Using this method, you can perform assorted actions on newly created machines, e.g.: modifying files, preinstalling & preconfiguring software, executing any statements that would normally be executed via the terminal.

The general rule is that configurable option names should begin with script_prefix to be recognized as containing a custom script.
Then, choices under the option have their own names which are matched with a name of existing file with the corresponding script under the yourWHMCS/modules/servers/DigitalOceanDroplets/scripts path.
Note that files with scripts have to have exactly extension corresponding to the given entries in the configurable options.

In the example above, there are two options: php5.yml and php7.yml, therefore it makes the module read corresponding files:

  • modules/servers/DigitalOceanDroplets/scripts/php5.yml

or

  • modules/servers/DigitalOceanDroplets/scripts/php7.yml

You can add many scripts in the exact way.

Management

DigitalOcean Droplets For WHMCS allows your customers to manage their DigitalOcean Droplets via the client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options which enables you to view current VPS resources and change VPS specifications through changing configurable options and pressing 'Change Package' .
2. Module commands enables you to manage VPS status.
3. Here you can find VPS details and refresh them through pressing the 'Refresh Details' icon.
4. Scheduled tasks status can be found in this table.
5. In marked custom fields you can find IDs of VM and private flavor.

DOD 24.png
If you decided to select the Use Volumes feature, you will see an additional section named Volumes.
File:DOD 24 1.png

Ordering

Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.

Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.
Important: VPS is not created immediately after ordering 'Create' . Therefore, it is wise to inform your clients about the delay.

DOD 25.png

Client Area

Client area interface of DigitalOcean Droplets should look like the one on the screen below. As you can see, the control panel contains useful options needed for managing a VPS.

Module allows your customers to easily start/stop, pause/unpause, resume, soft reboot, hard reboot and reset network of their servers through pressing the specific button.
Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.
At 'Tasks' your customers can view all requested tasks that was not yet completed.
Each task has additional information bounded to them, like a type of task, attempts to perform tasks or a last returned response.

DOD 26.png

Volumes

In case your DigitalOcean Droplets is running with the Use Volumes option, the client area may look a bit different. It will now include an additional section named Volumes
DOD 26 1.png

Rebuild

The rebuild feature allows your clients to change a server image.

Press the 'Rebuild' button as shown on the following screen in order to move to the rebuild page.

DOD 27.png
To reinstall your server, choose an image and confirm through clicking on 'Rebuild' .
DOD 28.png

Rescue Mode

The rescue mode provides a mechanism for a VM access even in case the VM's image renders the instance inaccessible - e.g. if instance's filesystem becomes corrupted.

The rescue VM will be launched to permit the user to fix their VM.

File:DOD 48.png

Before you continue please note that the rescue VM will be set up with the same network configuration as the real VM.
Moreover, a new root password will be generated and the VM status will change to 'RESCUE'.
The new VM will also have a rescue image as the primary filesystem and the secondary filesystem would be the original VM's primary filesystem.

File:DOD 49.png
When you want to disable the rescue mode, click the 'Unrescue' buton. TheVM status will then also return to 'ACTIVE'.
File:DOD 50.png

Backups

Your customers can also create a backup of VPS. To do so, press the 'Backups' button.
DOD 31.png
Now, choose a backup name and click 'Backup Now' .
DOD 32.png
To restore a VPS from backup, simply press the 'Restore' button next to it.

As you may notice on the following screen, presented earlier the 'First Backup' backup was replaced with the 'New Backup' .
It was caused by a backup routing feature which was triggered by reaching the backups file limit.

DOD 33.png

noVNC Console

One of the most interesting functionality is a noVNC console where your clients can remotely manage their server.

To access it, simply click on the 'Console' button.

DOD 29.png
noVNC is a browser based VNC client. It was implemented using HTML5 Canvas and WebSockets.
DOD 30.png

VM Protection

In the product configuration page you can enable the 'Protect VM After Creation' option which prevents the termination or rebuilt of VM.

The selected status of this protection will be applied to both admin area and client area.

File:DOD 51.png
Moreover, if the 'Protect VM' option is enabled in the client area, the client will be empowered to toggle the current protection status.
File:DOD 52.png

Firewall

The firewall management page allows your customers to view, add or delete existing rules on a security group assigned to the product.

To add a new firewall rule, use the button marked on the following screen.

File:DOD 53.png
Next, choose the rule type (TCP or UDP), direction (inbound or outbound) and ether type (IPv4 or IPv6).
Depending on the port you choose, you will be able to add a rule for a single port only, a range of ports or all ports at once. You can also select one of the predefined ports or use a custom one.
Finally, provide a single IP address or specify the range of addresses using the CIDR format (e.g. 10.10.10.1/24) and add rule description if you wish.

Press 'Add' when ready.

File:DOD 54.png

Network Configuration Cases

DigitalOcean Droplets For WHMCS allows you to set up two types of network.

The first one is a network without a floating IP address.
To set up this type of network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network' .
On the following screen you can view an exemplary topology of such network.

File:DOD 36.png
The second type of network is the network with a floating IP address.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network' .

File:DOD 37.png

Configurable Options

In case that standard configuration is not fitting your needs, you can adjust it through configurable options.

To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press the edit button next to a configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

File:DOD 38.png
Here you can view the products that this configurable option group is assigned to.

Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 8GB (8192 MB) RAM.
To do so, edit 'ram|RAM' by pressing the edit button as shown on the screen below.

File:DOD 39.png
You will see a popup window, so make sure that your browser will not block it.

To add a new option, enter it in a textbox under all other options. If you want to replace it with an option you currently have, simply edit its text box.
Next, press 'Save Changes' .

File:DOD 40.png

Management of Billing

When you combine DigitalOcean Droplets For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers based on the server resources used by them.
Note: Advanced Billing currently supports only API prior V3 (DigitalOcean Ocata). A new compatibility will be added soon.

File:DOD 42.png
With Advanced Billing module, you can also display your customers the current server resource usage, their cost, usage history and charts.
File:DOD 43.png

Tips

1. Due to some requests may take time to be completed, we implemented 'Scheduled Tasks' .

Tasks visible at 'Scheduled Tasks' are subsequently performed by a cron job.
Full list of tasks supported by 'Scheduled Tasks' are: create, terminate, change package, remove IP address and remove backup.

2. Important: module has to use admin endpoints instead of public endpoints.

In properly configured DigitalOcean server, wget from WHMCS server should be able to get any data from any admin endpoint.
Sample successfull requests: 

wget DigitalOcean:9292
--2014-03-31 09:35:24-- http://DigitalOcean:9292/
Resolving DigitalOcean(DigitalOcean)... 192.168.1.222
Connecting to DigitalOcean(DigitalOcean)|192.168.1.222|:9292... connected.
HTTP request sent, awaiting response... 300 Multiple Choices
Length: 520 [application/json]
Saving to: `index.html'

100%[==========================================================>] 520 --.-K/s in 0s

2014-03-31 09:35:24 (118 MB/s) - `index.html' saved [520/520]



wget DigitalOcean:8777
--2014-03-31 09:41:05-- http://DigitalOcean:8777/
Resolving DigitalOcean(DigitalOcean)... 192.168.1.222
Connecting to DigitalOcean(DigitalOcean)|192.168.1.222|:8777... connected.
HTTP request sent, awaiting response... 401 Unauthorized
Authorization failed.
3. A primary IP address is always assigned by DigitalOcean server when a VM is created Therefore, if you decide to order 2 IP addresses, then 3 addresses will be assigned.
The primary one and the two additionally ordered. If you wish only one IP address to be assigned to a single product, please set the filed 'Default Number Of IP Addresses' to '0'
or leave it empty in the product's 'Module Settings'.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. In case of persisting connection problems, please make sure you have the following ports open: 
8774, 35357, 9292, 5000, 8777, 9696, 8776
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=DigitalOcean_Droplets_For_WHMCS&oldid=39582"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
DigitalOcean Droplets For WHMCS