Your clients will receive the chance to handle their machines remotely through start, stop, and reboot options as well as access flexible graphs on their server usage.
Moreover, the module allows you to adjust all product features, and supervise the status of each supplied machine at all times.

We will guide you step by step through the whole process.

Extracted files in your WHMCS directory should look like this:

Note: The module uses modified AWS files provided by WHMCS in the 'vendor' folder. In order for the module to work properly, it is necessary to overwrite these files with the files from the module.
Please keep this in mind when installing a WHMCS update, because then you may also need to overwrite these files with the files from the module again.

The file is located in '/yourWHMCS/modules/servers/AmazonLightsail/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 '/yourWHMCS/modules/servers/AmazonLightsail/'.

It will be used to assign IP addresses to created machines as well as to obtain passwords for Windows OS.

php -q /yourWHMCS/modules/servers/AmazonLightsail/cron/cron.php queue

It is suggested to run the cron every 5 minutes.

Underneath, you will find detailed instructions on where to find this information.

Note that this is the only place where you can later on find the corresponding secret key, it will not be visible next to the Key ID in the panel.

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

Now, provide the previously generated 'Access Key ID' and 'Secret Access Key'. Then, check the connection and if successful, save the changes.

Important: If you are using WHMCS V7.8.X, then a fatal error may occur when trying to save server settings without providing any hostname or IP address details, even if the module configuration does not require them.
In this case, try to provide anything in the hostname field. For this reason, 'Test Connection' may sometimes not work either. Please note that this is a bug occurring in WHMCS, not the module itself.

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 Lightsail panel, here also you can configure such options as:

• Region - Choose a geographical area with a set of Lightsail resources. The closer the instance is to your users, the less latency they will experience.

• Availability Zone - Each AWS Region has up to six 'Availability Zones' . By launching instances in separate 'Availability Zones' , you can protect applications from the failure of a single location.
  To ensure that resources are distributed across the 'Availability Zones' for a region, they are independently mapped to identifiers for each account.
  For example, 'us-east-2a' might not be the same location as 'us-east-2a' for another account. Learn here more about 'Availability Zones' in Amazon Lightsail.

• Platform - Lightsail images are available on two platforms: 'Linux/Unix' or 'Windows' . Once you choose a platform, you can select a corresponding blueprint of the operating system.

• Blueprint - select which base operating system (OS) with or without preinstalled application should be installed. You can select between an Ubuntu Server image with an application or development stack preinstalled, or a Windows OS with SQL Server 2016 Express preinstalled. Note that available options depend on the previously selected 'Platform' and some blueprints cannot be launched with certain Instance Plans.

• Instance Plan - Select resources available for the instance. Please note that the better the instance resources, the higher the monthly costs. Moreover, some blueprints require more powerful resources. You can read more about Amazon Lightsail pricing here.

• Tag Name - Define a tag name; this label will be assigned to Lightsail resources.

• Static IP Address - Decide whether to assign to an instance a static, fixed and public IP address. Note that this will be done a moment after instance creation during the next cron execution. You can find out more about Lightsail static IP addresses here.

• User Data - You can specify user data to configure an instance or to run a configuration script during launch. This field is optional.
  Tutorial on how to use this option can be found here.

• Log API Requests - Enable to allow storing information on API requests in the 'Module Log' section in your WHMCS.

Configurable options can be used by your clients to select each virtual machine 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.

Please be aware, that this field can be left as optional for Linux/Unix as well as Windows platforms.
Int that case the necessary keys will be generated by Amazon itself and will be given in the 'Connection Details' window.

The following formats are supported:

• OpenSSH public key format (the format in ~/.ssh/authorized_keys)
• Base64 encoded DER format
• SSH public key file format as specified in RFC4716
• SSH private key file format must be PEM (for example, use ssh-keygen -m PEM to convert the OpenSSH key into the PEM format)
  

Create an RSA key. Amazon Lightsail does not accept DSA keys. The supported lengths are 1024, 2048, and 4096.

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}( [^@]+@[^@]+)?# 

Remember that API allows such action only once, during the initial VM creation.

This includes supervision of such features like:

1. Configurable options which enable you to view the chosen server details
2. Module commands to allow easy and quick management of the server
   Important: Currently Change Package command can be only used for enabling or disabling 'Static IP Address' option.
   The change of the instance plan is currently not supported due to the complex nature of its implementation.
3. Service actions, including: Start, Stop and Reboot the server as well as display Connection Details for remote connection to the instance
4. Instance details that provide the current status, resources and options set.
5. Attached disk details
6. List of scheduled tasks with its type specified, status and date.

At this moment cliens can also optionally provide their public SSH key.
Please note that this key should be in one of the OpenSSH standard formats which are supported by API, e.g. ssh-rsa.

The module allows your customers to easily start, stop and reboot their server instance through pressing the corresponding buttons.
Clients can also check the server status with its details, view assigned public and private IP addresses, view disk details as well as control the list of currently scheduled tasks.

This data will vary depending on whether the instance is based on Linux/Unix or Windows as well as if the public SSH key was provided during the order.

To connect to an instance on the Linux/Unix platform, clients can use an SSH client application such as PuTTY (learn more).
Depending on the configuration of the instance, the popup window will display the instance IP address, connection protocol, username, and private or associated public SSH key.

For Windows-based instances, clients can also connect to their instance using an RDP client such as Remote Desktop Connection (learn more).
Depending on the configuration of the instance, the popup window will display the instance IP address, connection protocol, Windows username and generated password in its decoded or encoded form.
If Windows password is encoded it can still be somehow decrypted using this Amazon method.

They can also switch the timeline of graphs by choosing a new one from the 'Edit' dropdown menu. Clients can pick between '1 hour', '6 hours' '1 day', '1 week' and '2 weeks'.

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.