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 if they want to reset Droplet's password to a new one.
  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.

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 - Choose the size slug 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 user-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 'cloud-config' file or 'Bash' script which will be be used to configure the Droplet on first boot.
  The script you want to provide has to be located in the '/modules/servers/DigitalOceanDroplets/storage/userDataFiles/' directory and should have .sh file extension.
  You can learn more here how to use cloud-config for initial server setup.
• Snapshots Limit - Snapshots provide a full copy of a Droplet, saving everything from a Droplet’s disk to a disk image. Here you can provide
• Tags - Here you can apply custom labels for the Droplet. 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.

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 creadentials 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 eariel configuration will be used.
More information about the WHMCS configuration options can be found here.

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

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.

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

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.

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.

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

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.

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!

You can achieve it by writing:

chpasswd:
 list: |
 ubuntu:newpass01
 expire:False

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:

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.

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.

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.

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.

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

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

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.

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.

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

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

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

Press 'Add' when ready.

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.

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

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

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.

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

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.

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.

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. 

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.

8774, 35357, 9292, 5000, 8777, 9696, 8776