The module will empower your clients to exert full control over their virtual machines through such actions as power on/off, reboot, server rebuild and many more.
At the same time you will be enabled to carry out a thorough supervision of all tasks performed on virtual servers directly from the admin area.

We will guide you step by step through the whole installation and configuration process.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

The content of the chosen PHP version files to upload should look like this.

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

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

This folder is available at '/your_whmcs/modules/servers/DigitalOceanDroplets/'.

• Mail cron - will be used to send emails to clients after Droplet creation, rebuilt or password reset.
  You will find more information on this topic in the product configuration section. We suggest running the cron every 5 minutes:

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

• Tasks cron - will be used to remove volumes from the panel after their termination. If not set, the admin will have to delete them manually
  Moreover, from the 1.4.0 module version it will also assign/unassign floatings IPs on the Droplet creation or its upgrade ( 'Change Package' module command).
  We suggest the cron to run every 5 minutes:

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

• Firewall cron - will be used to synchronize Firewalls assigned to Droplets directly in the panel.
  You will find more information on this topic in the product configuration section. We suggest that the cron should run every hour:

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

  Remeber to replace 'your_whmcs' with your WHMCS root path.

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

Note: If you have WHMCS V7.8.X or later, we recommend using your 'previous experience' of the server configuration instead of the new wizard tool.

Now, in the 'Password' field provide your DigitalOcean API token and check the connection. If successful, save changes.

Note: To find your API token, log in to your DigitalOcean panel and go to the API section where you can generate a new token.
You will need a token with read and write permissions. Remember to copy and store the token in the safe place because it will no longer be visible in the panel.
Click here to see an example where to find it.

Note 2: The 'Hostname' field is not used by the module, but if you use WHMCS V7.8.X, then a fatal error may occur when trying to save server settings without providing any hostname or IP address details.
In this case, try to provide anything in the hostname field. Please note that this is a bug that occurs in WHMCS, not in the module itself, and it may also appear in further versions of WHMCS.

Click on 'Create a New Group' .

To do so, first click on 'Create a New Product' .

The module should automatically save and reload the settings. If not, click on the 'Save Changes' option manually.

Just like when creating a new virtual machine in your DigitalOcean panel, here also you can configure such options as:

• Project - Select a project on which the droplet will be created.

• Region - Select the data center region. More distant server locations may increase the server's latency without providing any practical benefits to clients.

• Size Slug Plan - Choose the size slug plan based on which resources will be allocated to the Droplet. You can read more about size slug indications here.
  Note: If you want to change their names to more user-friendly, you can do it in a language file.

• Image - Select the image of the system that will be installed on Droplet.

• Additional Volume Size - Allows you to create and attach additional SSD storage volume to Droplet in the provided size (in GB).
  If left empty or set to 0, then the volume will not be created and attached. Here you can find more information about DigitalOcean Block Storage.

• User Data - Choose the execution script which will be used to configure Droplet on the first boot. Go here to find more information about how to use these scripts.
  Note: User Data scripts are optional for product configuration if you do not want to use them, simply set this field to the 'Do not use' option.

• Floating IPs - Enable to automatically assign floating IP address to Droplet on creation. Click here to find out more about floating IPs.

• Backups - Enables automatic system-level backups. It can be used for backup images, to revert the server or create new Droplets. Click here for more information.

• Monitoring - Enables additional Droplet metrics collection, monitoring, and alerting. Here you can find out more.

• Snapshots Limit - Snapshots provide a full copy of a Droplet, saving everything from a Droplet's disk to a disk image. Here you can define the maximum number of snapshots that can be stored at one time.

• Firewalls Limit - Firewalls block your servers and machines from external attacks. Here you can define the maximum number of firewalls that a client may add per virtual machine. Enter '0' to disable firewalls, leave empty to set no limits.
  Note 1: You may create more firewalls in the panel which will be assigned with a cron run, the limit in such case can be exceeded.
  Note 2: A cron command is required to synchronize firewalls assigned and managed in the DigitalOcean Droplets Panel.

• Inbound Firewall Rules Limit - Enter how many inbound rules a user can create per one firewall. Enter -1 for unlimited.

• Outbound Firewall Rules Limit - Enter how many outbound rules a user can create per one firewall. Enter -1 for unlimited.

• Total Limit of Firewall Rules - Enter the total number of rules that a user can create per one firewall. Enter -1 for unlimited.

• Tags - Here you can apply custom labels for the Droplet. If you want to add multiple tags, separate them with a comma. Read more about tags here.

• IPv6 - Enables public IPv6 networking for Droplet.

• Private Networking - Adds Droplet-to-Droplet networking, within the same region.

• Debug - Enables logging of API requests and responses to WHMCS module log which may be useful if you experience any problems with the module.

Important: Before providing any extra features to your WHMCS clients, remember to familiarize yourself with the additional costs that may be applied to your DigitalOcean account.

Due to API limitations, all emails with Droplet credentials can only be sent to your DigitalOcean profile email address set in the panel here.
This applies to messages with credentials sent after Droplet creation as well as messages sent after password reset.
The solution to this problem is email piping that will be used to receive messages sent to your DigitalOcean mailbox and then forwarded through the templates further to your WHMCS clients.

Note: Even though the module filters the received messages in your mailbox, we recommend that you use a separate mailbox for your main DigitalOcean profile account to avoid any issues with non-DigitalOcean content.

After setting up the dedicated mailbox, provide its valid credentials below and test whether the connection has been established correctly.

Note: There is available an option to 'Disable Certificate Validation'. Please toggle this option ONLY if you are having troubles with the connection. The certificate validation will be omitted when connecting to an email box.

You will find here six options that can be enabled and then will be available to your clients in their client area. These options are:

• Rebuild Droplet - if enabled, clients are allowed to rebuild their virtual machine in an adequate section.

• Snapshots - if enabled, clients are granted access to snapshots section

• Task History - if enabled, clients are allowed to view the history of the tasks

• Backups - if enabled, clients are allowed to view the history of the tasks

• Kernel - if enabled, clients are allowed to change their current kernel to any other available
  Note: Kernels' management is dependant on the selected OS and must be active in the panel. Before enabling, make sure the option functions correctly in the panel.
  For more info on Kernels move here.

• Firewall - if enabled, clients are allowed to create firewalls and manage inbound and outbound rules

• Reset Password - if enabled, clients are allowed to reset the password

• Change Hostname - if enabled, clients may give their hostname a unique name

• Rebuild Initially Chosen Image Only - if enabled, clients will be able to rebuild the droplet only on the OS that was originally chosen for the purchased product instead of to any images that you can select below.

• Available Images To Rebuild - Select OS images, One-click apps, and Snapshots from available to allow the client to use when rebuilding a droplet.
  Please note, that if you leave this field empty then all available OS images and One-click apps provided by DigitalOcean will be displayed in the client area to rebuild except the snapshots.
  Keep in mind that the available here list of OS Images includes all the snapshots, including the clients' private ones. Be careful when selecting them.
  You can also ignore this option if you want to allow rebuild Droplet with only initially chosen image.

Configurable options can be used by your clients to select each Droplet parameters individually during order placement.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.

This field is optional. It allows your clients to insert their public key in order to be able to log in to Droplet without using a password.
The provided key should be in one of the OpenSSH formats which are supported by DigitalOcean API. This includes the following types:

• ssh-rsa
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ssh-ed25519

If you would like to limit the possibility of entering the key e.g. only to the 'ssh-rsa' format, you can use the regular expression in the validation field, such as:

#ssh-rsa AAAA[0-9A-Za-z+/]+[=]{0,3}( [^@]+@[^@]+)?# 

More information about how DigitalOcean handles SSH keys and how to create them can be found here.
If you do not want this field to be available to customers during the ordering process, simply uncheck 'Shown on Order Form' option.
Remember that API allows such action only once, during the initial VM creation.

Important: During tests we discovered that some OS images such as 'CoreOS', 'CentOS' or 'FreeBSD', may require the SSH key to create a Droplet.
In such cases, we recommend that you additionally check the 'Required Field' option for such products.

Please also note that when the SSH key is provided, DigitalOcean may not send the welcome email after Droplet creation.

You can provide your own scripts using 'cloud-config' or 'Bash'. By default, we provide two exemplary scripts for changing the OS password or inserting SSH key, which you can use as a reference.
The script you want to include has to be located in the '/your_whmcs/modules/servers/DigitalOceanDroplets/storage/userDataFiles/' directory and may not exceed 64 KiB in size.

You can provide multiple scripts for configurable options, but only one can be chosen for Droplet creation.
If you would like to execute several different scripts at once, you should try combining them within a single file.

Remember that the scripts you provide should be compatible with the given distribution.
You can learn more here and here about how to use cloud-config for the initial server setup.

This includes supervision of such features like:

1. Configurable options which enable you to view the chosen Droplets resources.
   Important: Due to API limitations, the only two configurations possible to modify for the already created VM through the 'Change Package' functionality are the 'Size Slug Plan' option for Droplet resizing and 'Floating IPs' for assign/unassign.
   And even this actions may not always be allowed! You can also change the snapshots, backups, firewalls and rules limits, which values are only kept locally on the WHMCS server.
2. Module commands, service action and additional options enable you to manage Droplet status and features.
3. Server information provides you with the current status, resources and options set for the Droplet.

4. Network information presents assigned IPv4 and IPv6 addresses to the Droplet along with their gateway, interface type, used netmask or CIDR as well as floating IP, if assigned.
5. You can easily view and make new snapshots of the Droplet.
6. The automatic Droplet backups can be restored here as well.
7. You can also rebuild the Droplet OS to a different distribution.
8. And finally, display all actions taken on Droplets in the tasks history table.

Based on the custom SSH key field configuration, you might also insert your public SSH key, which will allow you to log in to a Droplet without the need to use the password.
Note that this key should be in one of the OpenSSH standard formats which are supported by API, e.g. ssh-rsa.

After the order placement and successful VM creation, the Droplet credentials will be sent to the client's email address according to the set cron execution intervals.

The module allows your customers to easily power on/off, shutdown, reboot and reset password of their servers through pressing the corresponding buttons.
Clients can also rebuild the server, create and restore snapshots, create firewalls and manage their rules, access automatic backups and view tasks history with their current status.
Additionally, clients can change the name of the hostname, view the current Droplet parameters, resources and all set options, as well as the assigned IP addresses.

Press the shown below button in order to reinstall your server to the chosen image and confirm your choice.
Please remember that this will also wipe the previously saved data on the VM disk.

Note: This process happens automatically within a pre-determined scheduling window, and is completed in the background while the Droplet is running.
Client cannot force the creation of an additional copy on demand or delete it - this however can be achieved by using snapshots feature.

Press 'Create Firewall' button to create one.

Press 'Edit' icon to move to the firewall rules management page.

• Application - you can select one of the predefined applications on the basis of which the default port will be automatically filled in
• Rule Type - configure the firewall rules for incoming or outbound traffic
  • Inbound - the specified ports will accept inbound connections only, any other traffic will be blocked
  • Outbound - the outbound traffic will be allowed for the specified ports, any other traffic will be blocked

• Protocol - Select the type of allowed traffic:
  • TCP
  • UDP
  • ICMP

• Ports - Provide ports to allow the traffic on, accepted forms:
  • single port (eg. 80)
  • range (eg. 8000-9000)
  • ‘all’ – to open all ports
  • leave empty - for ICMP protocol type

• IP Address - add IP addresses, use coma to separate. Both IPv4 and IPv6 are supported.
  To add a rule for all addresses at once use:
  • '0.0.0.0/0' for IPv4
  • '::/0' for IPv6

It already has a built-in support for DigitalOcean DNS server.

Use these features wisely as they can increase your Droplets maintenance costs.

• Droplet Name - {$droplet_name}
• User Name - {$droplet_user}
• Password - {$droplet_password}
• Dedicated IP - {$service_dedicated_ip}

Please note that the last merge field has been added into the template in version 1.3.0. In case you started using the module earlier, you may add it manually.
Underneath, you can see how the custom template looks like. You may surely edit it at 'WHMCS' → 'Setup' → 'Email Templates'.
You will find there the second custom eamil template: 'Digital Ocean Password Reset Email' as well.

If you are upgrading a module from the version prior to 1.4.0 to a newer one, we also suggest updating the frequency of execution 'cron.php Tasks' as suggested on step 7 of the installation guide.

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.

This may be caused by the requirement to use the SSH key by given distribution instead of a password.

Please try choosing for example a different region or distribution.