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: This is the only place where you can find the corresponding secret key later. It will not be visible next to the Key ID in the panel.

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. Please note that this is a bug that occurs 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.

• Snapshot - select which of the created system snapshots will be used to base the VM installation on. If you select 'None', the following 'Blueprint' option will be used to base the installation.

• Blueprint - select which base operating system (OS) with or without a 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.

• Snapshots Limit - Set a limit for a maximum number of taken manual snapshots that the client can have at a given time. Set -1 for unlimited.
  Please remember that Amazon takes fees for each snapshot - click here to find out more.

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

• Email Template - Choose an email template that will be used to send messages to clients after the successful creation of the instance.

• 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 his will be done a moment after instance creation during the next cron execution.
  You can find out more about Lightsail static IP addresses here.

• Auto Generate SSH Key - If you enable, SSH key pairs will be automatically generated if clients do not provide them during the instance creation.

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

• Client Area Section - Here you may provide the HTML code and display the content in the client area. Before using this option, please make sure that you are familiar with the instruction that can be found here.

• Random Domain Prefix - Here you can provide the domain prefix that will be applied if the domain has not been provided.
  You may use WHMCS parameters e.g. {$hostname} or any other valid hostname characters (a-z, A-Z, 0-9,. and -)

Configurable options can be used by your clients to select each virtual machine parameters individually while placing an order.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.

Important! If you come across some errors with displaying values in the client area, please check if you closed brackets {}.

1. The values that can be displayed in the client area:

{$serviceid}, {$pid}, {$serverid}, {$domain}, {$username}, {$password}, {$producttype}, {$moduletype}, {$configoptionX}, {$server}, {$serverip}, {$serverhostname}, 
{$serverusername},{$serverpassword}, {$serveraccesshash}, {$serversecure}, {$serverport}, {$bundles}, {$region}, {$zone}, {$platform}, {$snapshot}, {$blueprint}, {$snapshotsLimit}, 
{$tagName}, {$userData}, {$emailTemplate}, {$userid}, {$orderid}, {$packageid}, {$server}, {$regdate}, {$domain}, {$paymentmethod},{$firstpaymentamount}, {$amount}, 
{$billingcycle}, {$nextduedate}, {$nextinvoicedate}, {$termination_date}, {$completed_date}, {$domainstatus}, {$username}, {$password}, {$notes}, {$subscriptionid}, 
{$promoid}, {$suspendreason}, {$overideautosuspend}, {$overidesuspenduntil}, {$dedicatedip}, {$assignedips}, {$ns1}, {$ns2}, {$diskusage}, {$disklimit}, {$bwusage}, 
{$bwlimit}, {$lastupdate} 

2. On/Off values that you can choose from:

{$clientAreaHistory}, {$clientAreaMetric}, {$clientAreaShowDisk}, {$logApiRequests}, {$staticIpAddress}, {$clientAreafirewall}, {$clientAreasnapshots}, 
{$autoGenerateSSHKey}, {$clientAreaServiceActions} 

3. Access values provided in Arrays:

Please make sure that the provided value complies with this pattern {$ arrayName . fieldName } for example: {$customfields.InstanceTags}, {$clientsdetails.city}

• {$clientsdetails} :
  

{.userid}, {.id}, {.uuid}, {.firstname}, {.lastname}, {.fullname}, {.companyname}, {.email}, {.address1}, {.address2}, {.city}, {.fullstate}, {.state}, 
{.postcode}, {.countrycode}, {.country}, {.phonenumber}, {.tax_id}, {.password}, {.statecode}, {.countryname}, {.phonecc}, {.phonenumberformatted}, {.telephoneNumber}, 
{.billingcid}, {.notes}, {.twofaenabled}, {.currency}, {.defaultgateway}, {.cctype}, {.cclastfour}, {.gatewayid}, {.securityqid}, {.securityqans}, {.groupid}, {.status}, 
{.credit}, {.taxexempt}, {.latefeeoveride}, {.overideduenotices}, {.separateinvoices}, {.disableautocc}, {.emailoptout}, {.marketing_emails_opt_in}, {.overrideautoclose}, 
{.allowSingleSignOn}, {.email_verified}, {.language}, {.isOptedInToMarketingEmails}, {.lastlogin} 

• {.email_preferences} :
  

{.general}, {.invoice}, {.support}, {.product}, {.domain}, {.affiliate} 

• {$customfields} :
  

{.InstanceId}, {.InstanceTags}, {.sshKey} 

As an example, we provide:

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 displayed 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 the supervision of such features as:

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: Since version 1.3.0 of the module the 'Change Package' command can be used for enabling or disabling the 'Static IP Address' option as well as changing the 'Instance Plan'.
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 their type, status and date

At this moment clients 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 take instance snapshots, manage firewalls, check the server status with its details, view assigned public and private IP addresses.
Moreover, it is easy to see disk details, access usage graphs, 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 on whether 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.
Here is a short guide on how to connect with openSSH:

• Create a file (e.g. id_rsa) with SSH Private Key
• Create a file with a .pub extension (e.g. id_rsa.pub), with the contents of the SSH Cert Key
• Run the command:

 ssh username@ip -i ida_rsa 

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

Note that when a Lightsail instance is created, some network ports are open by default so the instance can accept public network connections.

Clients can add here new rules, edit existing ones or delete them.

You can also find a complete list of port settings, application layer protocol types, and transport layer protocol types in this Amazon documentation.

In the snapshots section clients can create new snapshots of their instances, view previous snapshots or restore instance from a snapshot.
The number of allowed snapshots the client can have taken at given time can be limited in the product's module settings or by configurable options.

Please note that Amazon also takes additional fees for each created snapshot.

Note that the name can contain from 2 to 200 characters which can be only alphanumeric, numbers, periods, dashes or underscores.
If Windows is used for instance, it should be also stopped before creating a snapshot.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following field:

• Instance ID

Now, fill out the field with the ID of the machine that you wish to assign to this client.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

This is because Amazon requires snapshot names to be unique to each AWS Region in your Lightsail account, not just within a single instance.
Otherwise, customers at WHMCS could often see the message that a particular snapshot name has already been taken up by someone else.
For the domain prefix name, 55 characters from 255 previously available for the snapshot name have been reserved .

• Navigate to the ~/langs/ directory located within the following yourWHMCS/modules/servers/moduleName/langs/ path.
• Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure:

 ~/langs/overrides/english.php.

• Open the newly created override file to edit its contents.
• At the beginning of the file, indicate the used code, for instance, you can use: <?php for PHP code.
• Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.

For example:

Original yourWHMCS/modules/servers/moduleName/langs/english.php:

 $_LANG['Search'] = 'Search';

Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:

 $_LANG['Search'] = 'Look for';

Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them.
Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.
Consequently, the override lang file might include only one or just a few lines.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

After the module update we strongly recommend to open one of the product's module settings tab to make sure that all upgrading processes have been completed successfully.

Opt for the Open Source version of your Amazon Lightsail For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.