ServerPilot: Shared Hosting: Installation

  • Upload the modules folder
  • Visit Setup>Addon Modules
    • Click activate
    • Click configure
      • Enter your license, Client ID & API Key
      • Tick Full Administrator
      • Click Save
  • Go to Addons > Server Pilot: Shared Hosting > Servers
    • Copy the ID for the server
  • Go to Setup > Products/Services > Servers
    • Add a new server
      • [Name:] Choose a suitable name
      • [Hostname:] The hostname of the server
      • [IP Address:] The IP of the server
      • [Type:] Serverpilot_sh
      • [Username:] Paste the ID of the server that you copied above
    • Save the server, and repeat for additional servers
    • Create a new server group called ‘ServerPilot_SH’
      • Assign the servers that you just created
  • Go to Setup > Products/Services > Products/Services
    • Create a new product
    • Under ‘Details’
      • [Require Domain:] yes
    • Under ‘Module Settings’
      • [Module Name:] Serverpilot_sh
      • [Server Group:] The group that you just created
      • Adjust the SSL, Domain and Database settings
    • Save the product
    • Under ‘Custom Fields’

      • [field name] wordpress
        • [description] Would you like WordPress to be automatically installed?
        • [type] Drop Down
        • [select options] no,yes
        • [required field] & [show on order form]
      • [field name] wordpress_title
        • [type] text
        • [show on order form]
      • [field name] wordpress_user
        • [type] text
        • [show on order form]
      • [field name] wordpress_password
        • [description] Min. 8 characters
        • [type] password
        • [show on order form]
      • [field name] wordpress_email
        • [type] text
        • [show on order form]
    • Save changes (you might need to do this after adding each custom field)
  • Done. Place a test order to ensure that the module is working

 

Digital Ocean v2: Migrate V1 to V2

Digital ocean module v2 is not a direct upgrade for v1. here are the steps required to migrate a client from v1 to v2.

Setup Products

  • Please ensure you have followed the setup guide and have a v2 product ready.

Migration

  • Please see the following video which shows how to copy droplet data to a new service

Snapshots

  • If a client has snapshots, you will need to order a snapshot product and manually enter the snapshot_id and name (similar to adding droplet_id in the above video). The snapshot_id and name can be found in your Digital Ocean client area.

Digital Ocean v2: Customization

There are several .tpl files in /modules/servers/ folders that can be edited 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 v2: Email Piping or POP/IMAP import

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.

You only need to setup POP/IMAP or Piping, not both.


 

POP/IMAP IMPORT:

Setup the login details for your mail server:

Screen Shot 2015-02-11 at 18.52.50

Then create a php cron job to the import file, we recommend every 5 minutes e.g.

*/5 * * * * /path/to/php /path/to/modules/addons/digitalocean2/import.php

Next Step.. Customization

Digital Ocean v2: Installation

  • Upload the modules folder
  • cd to modules/servers/digitalocean2
  • ensure you have composer installed and run ‘composer install’
    • Note: after each module update, ensure you delete the vendors folder and re-run ‘composer install’
  • Visit Setup>Addon Modules
    • Click activate
    • Click configure
      • Enter your license & API token
      • Tick Full Administrator
      • Click Save
        View Screen Shot
  • Go to Addons > Digital Ocean v2 > Module Info
    • Edit the settings as required
    • {Note:} if you receive a cURL error, tick the disable_ssl option and save changes
      View Screen Shot
  • Go to Addons > Digital Ocean v2 > Products
    • Create the products as shown in the following video
    • {Note:} DO NOT change group names
    • {Note:} full list of images/regions can be found on the addon pages

Next Step.. Setup Email Piping or POP/IMAP import

Hourly Billing: Email Template

To send a credit warning email, you will need to create the following email template

  • Unique Name: Credit Warning
  • Type: General
  • Subject: Low Credit Warning
  • Body: (see below)
Dear {$client_name},
Your credit balance has gone below £{$low_credit}. 
Please top-up your credit, when your credit reaches £0 your services will be terminated.
Thanks {$company_name}

Vultr: Upgrading

Here are any manual steps required when upgrading.

All Versions

  • Delete the old files (/modules/addons/vultr and /modules/servers/vultr)
  • Upload the new files
  • Visit the addon page to run the update process

v1.0.0

  • To activate the availability hook, you must edit and re-save each product

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