XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.

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

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

The content of PHP version files should look like this.

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

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' .

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

• Mail cron - will be used to send mail messages to cliens after Droplet creation, rebuilt or password reset to a new one.
  More information about it you will find during product configuration. We suggest to set it up for each 5 minutes:

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

• Taks cron - will be used to remove volumes from the panel after their termination. If not set, the admin will have to delete them manually.
  We suggest to set it up for each hour:

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

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

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

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 one.
You will need a token with read and write permissions. Remember to copy and store it in the safe place because it will not be shown anymore in the panel.
Click here to see an example where to find it.

This field is used optionally for inserting by the clients their public key, in order to be able to log in to Droplet without the need to use a password.
The provided key should be in one of OpenSSH formats which are supported by DigitalOcean API. This include 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 'ssh-rsa' format, then you can also use the regular expression such as /^(ssh-rsa)\s.*/ in the validation field.
More information about how DigitalOcean handles SSH keys and how to create them, you can find here.
If you do not want this field to be available to customers during order process, simply uncheck 'Shown on Order Form' option, but remember that API allows its injection only once during the initial VM creation.

Important: During the tests we found out 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 using the SSH key is provided, the 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 OS password or inserting SSH key, which you can use as a reference.
The script you want to provide 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, bu only one can be chosen for Droplet creation.
If you would like to execute several different scripts at once, you should try combining them together into a single file.

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

Click on 'Create a New Group' .

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

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

In a similar way as when creating virtual machine in your DigitalOcean panel, you can configure such options as:

• 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 slugs indications here.
  Note: If you want to change their names to more friendly, you can do it in a language file.
• Image - Select the image of the system that will be installed on Droplet.
• Additional Volumne Size - Allows you to create and attach additional SSD storage volume to Droplet in the provided size (in GB).
  If left empty or entered 0 then volume will not be created and attached. Here you can find more information about DigitalOcean's Block Storage.
• User Data - Choose the exection script which will be used to configure Droplet on the first boot. Go here to find more information about how to use these scripts.
• 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 stored snapshots at the same time.
• Tags - Here you can apply custom labels for the Droplet. If you want add multiple tags, separate them using comma. Read more about tags here.
• Backups - Enables automatic system-level backups. It can be used to the 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.
• 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 incurred on your DigitalOcean account.

Due to API limitations all email massages with Droplets credentials can only be send 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 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 them through your templates further to your WHMCS clients.

Note: Even the module will accordingly filter the received messages from your mailbox, we recommend that you should 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 is established correctly.

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

These include features like:

1. Configurable options which enables you to view the chosen Droplets resources.
   Important: Due to API limitations the only possible configuration to switch by 'Change Package' for already created VM is 'Size Slug Plan' option for Droplet resizing and even this action might not always be allowed!
   You can also change the snapshots limit, which value is only kept locally on the WHMCS server.
2. Module commands, service action and additional options enables you to manage Droplet status and features.
3. Server information provides you the current status, resources and options set for the Droplet.

4. In network information you will find assigned IPv4 and IPv6 addresses to the Droplet with their gateway, interface type and used netmask or CIDR.
5. You can easily view and make a 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 other distribution.
8. And finally see all logged actions made on the Droplet 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 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 the successfully VM creation, the Droplet credentials will be sent to the client's email address according to the set cron execution intervals.

Module allows your customers to easily power on/off, shutdown, reboot and reset password of their servers through pressing the specific button.
Clients can also rebuild the server, create and restore a snapshots, access automatic backups and view tasks history with their current status.
Additionally at the below clients can view the current Droplet parameters, resources and options set, as well as the assigned IP addresses.

Press the 'Rebuild' button as shown on the following screen in order to move 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 that that 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 - this however can be achieved by using snapshots feature.

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

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

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 due to the demand to use the SSH key by given distribution instead of the password.

Given that try for example a different region or distribution.