Digital Ocean: Upgrading

Here are any manual steps required when upgrading.

Current Version < 0.2.7

  • Delete the old files (/modules/addons/digitalocean, /modules/servers/digitalocean and /images/do)
  • Upload the new files
    • If you are upgrading to v0.2.7+ and would like to enable Private Networking, you will need to create a configurable option ‘Private Networking’ with the options ‘No’ and ‘Yes’
  • Visit the addon page to run the update process

Current Version < 1.0.0

  • Delete the old files (/modules/addons/digitalocean and /modules/servers/digitalocean)
  • Upload the new files
    • If you are upgrading to v1.0.0+ and are still using Operating System and Data Center custom fields, you must change these to configurable options (see install instructions)
  • Visit the addon page to run the update process

Digital Ocean: Customization

You can edit the clientarea_*.tpl files as required
You can also edit the “Dedicated/VPS Server Welcome Email”. This must contain:

Main IP Address: {$service_dedicated_ip}
Username: {$service_username}
Password: {$service_password}

Digital Ocean: Changelog

V2.2.2
– Modified: minor fixes and improvements
V2.2.1
– Added: support for WHMCS 7.5 & PHP 7.1+
V2.2.0
– Added: option for client to add ssh key when creating droplet
– Added: option to have a live list of images, or list specified from configurable options when rebuilding droplets
– Added: check for php-imap on addon page
– Added: better error reporting in client area
– Modified: major code changes
– Modified: minor changes to addon pages
– Modified: minor clientarea tweaks
– Modified: uses image slugs when creating confgurable options
– Removed: email piping, must now use IMAP import
V2.1.3
– Fixed: fixed IMAP issue
– Added: debug information for support requests
V2.1.2
– Fixed: added workaround for custom field bug
V2.1.1
– Modified: updated updated database calls to use capsule
– Modified: other minor changes
V2.1.0
– Modified: updated client area for WHMCS 6
– Modified: will now power off droplet during resize
– Added: additional information in client area (e.g. memory, cpus, disk space etc.)
– Added: additional information in admin area (e.g. memory, cpus, disk space etc.)
– Added: ability for client to change kernel
– Added: user data can be added by clients on order form
V2.0.5
– Fixed: client area for custom themes
– Added: Resize disk when upgrading
V2.0.4
– Modified: Option to disable IMAP certificate validation
– Fixed: Fixed error caused by complex IMAP passwords
V2.0.2
– Fixed: Minor bug fixes
V2.0.1
– Fixed: Minor bug fixes
V2.0.0
– Added: Ability to create products with required settings from within module
– Added: If no hostname set srv{serviceid}.yourdomain.com will be set
– Added: IPv6 saved to ‘assigned IPs’ in WHMCS
– Added: All IPs saved under ‘notes’ in WHMCS to comply with proposed government regulations
– Added: debug log
– Added: send email on creation fail
– Added: push snapshot to all regions
– Added: DNS/Domain support
– Added: POP/IMAP import of emails
– Modified: Updated to APIv2
– Modified: Snapshots now a separate product (can be billed separately from droplet)
– Modified: IPv6 and Private Networking enabled by default (where available)
– Modified: Revamped ClientArea
– Modified: Processing bar when performing actions
– Fixed: Email piping
V1.0.0
– Module now only supports configurable options
– Modified admin area to display droplet IDs
– Modified create command so if hostname/domain is empty auto generate one
– Modified create option groups command to include all available regions/images
– Modified terminate command to always scrub data
– Modified email pipe to use whmcs “Dedicated/VPS Server Welcome Email” template
– Modified management actions to hide actions
– Added save username and default password to database
– Added clientarea.tpl for the client area
– Added destroy option on control tab
V0.2.7
– Added support for Private Networking
– Added support for global SSH Keys
V0.2.6
– Minor changes to cURL connection
V0.2.5
– Fixed backup issue after Digital Ocean system changes
– Added language file for email
V0.2.4
– Added suspend/unsuspend function
– Added language file for client area
V0.2.3
– API cURL fixes
– Added auto create option group button
V0.2.2
– Added option to use configurable option groups for Datacenter and Operating System
V0.2.1
– Added ability for client to rename/change hostname of droplet
– Added dropdown for choosing droplet size
– Added option to reinstall snapshot from another droplet in the same datacentre
– Added completed history items status to database for faster loading
V0.2.0
– Added support for backups
– Added support for snapshots
– Piping timeout bug fixes
V0.1.5
– Ability to get IP address if it is not assigned
– Option to fix cURL SSL error
– Better error messages
V0.1.4
– Display API error details
V0.1.3
– New admin addon page layout
– Added droplet list to addon page
– View current module version & latest version
– Upgrade/Downgrade droplets (see notes)
V0.1.2
– First Release
V0.1.1
– Development Version
V0.1
– Development Version

Digital Ocean: Email Piping

For clients to be able to receive the droplet login details, you will need to setup email piping. We recommend creating a separate email address (such as [email protected]) to avoid any issues with non Digital Ocean emails.

The email address must be setup with Digital Ocean here.

The correct paths and method of installation will depend on your server – please check with your control panel provider or system administrator for exact setup instructions.

Directadminmore info

In Directadmin you will create an email forwarder similar to the following:

"|/usr/local/bin/php -q /home/username/public_html/modules/addons/digitalocean/pipe.php"

cPanelmore info

In cPanel set pipe.php to 755 permissions. Open the pipe.php file and make sure the top line points to php on your server (if unsure of the correct path contact your system administrator),

Create an email forwarder and select ‘more options’ under the pipe to program option and enter the full path to pipe.php it will be similar to:

/home/username/public_html/modules/addons/digitalocean/pipe.php

Notes:

If your main domain does not point to the webserver (e.g. if you use Google Apps, or Office 365) you can setup a subdomain and point the MX records to the webserver e.g. [email protected]

Next Step.. Customization

Digital Ocean: Installation

  • Upload the modules folder
  • Visit Setup>Addon Modules
    • Click activate
    • Click configure
      • Enter your client ID, license & API key
      • Tick Full Administrator
      • Click Save
        1
  • Go to Addons > Digital Ocean
    • Create a new option group
    • {Note:} if you receive a cURL error, tick the disable_ssl option and save changes
      2
  • Go to Setup>Products/Services>Configurable Options
    • Add operating systems and regions as required
    • {Note:} DO NOT change group names
    • {Note:} full list can be found on the main addon page
      3 4
  • Go to Setup>Products/Services>Products/Services
    • Create a new product
      • [Product Type:] Dedicated/VPS Server
      • Continue
      • Details Tab
        • [Welcome Email:] None
      • Module Settings Tab
        • [Module Name:] Digital Ocean
          • Choose a size
            5
      • Custom Fields Tab
        • [Field Name:] droplet_id
        • [Field Type:] Text Box
        • Admin Only
          6
      • Configurable Options Tab
        • Choose the group you crated
      • Save Changes

Next Step.. Setup Email Piping