We will guide you step by step through the whole installation and configuration process.

Extracted files in your WHMCS directory should look like this:

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

Underneath, you will find instructions where to find them.

Click 'Go to APIs overview' as presented below.

Note: if any errors with API connection occur, please add another role: 'Owner' . Check common problems section to learn more.

Important! Once you proceed, the file with your private key will be downloaded to your computer.
Remember to store this file in a secure place because it is not possible to regain the key when the file is lost.

Now, provide your Google Cloud project ID as 'Username' and paste the content of the previously downloaded file with your key details in the 'Access Hash' field.
Finally, check the 'Test Connection' and save the changes.

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.

• Configuration:
  • Region - is a particular geographical location where you can host your resources. Each region consists of one or more zones.
  • Random Domain Prefix - enter here the domain prefix for instances where a specific domain is not provided. Only valid hostname characters, including letters (a-z), numbers (0-9), and hyphens (-), are permitted.
  • Machine Template - select a template to create a new VM based on the selected machine template. Note that only new VMs can be created based on templates, this option is not related to upgrades.
  • OS Distribution - choose a preferred OS distribution from the dropdown menu.
  • Disk Type - Standard persistent disks are efficient and practical for handling sequential read/write operations while SSD persistent disks are dedicated to enterprise applications
    and high-performance database needs that demand lower latency and more IOPS.
  • Zone - is a location within a region. Once the 'Region' is selected, then you can define a zone.
  • Machine Type - you can choose from many predefined machine types in each machine type family.
  • Image - select a preferred OS image.
  • Disk Size - provide the disk size in GB.
  • Tags - you may fill in network tags separated by commas or spaces.
  • User Data - choose the 'cloud-config' file or 'Bash' script which may be used to configure the virtual machine on the first boot.
• Custom Machine Settings:
  • Series - Select the custom machine type from available.
  • Number Of Cores - Define the number of cores that will be used.
  • Memory [MB] - Define the allocated memory amount for the machine, use MBs.
• Client Area Features:
  • Snapshots - enable if you want clients to access the 'Snapshots' section in the client area.
  • Graphs - enable to assure access to the 'Graphs' section in the client area.
• Network:
  • Network - choose a network.
  • Network Tier - there are two tiers available, 'Standard' and the ' Premium' one. More about the differences between them can be found here
  • IPv4 Address - you can enable the IPv4 Address.
    Note: This is required for the "Download RDP File" function in the client area.
  • Custom Subnet - select the 'Custom Subnet' option when manually configuring VMs. Enable this setting during subnet creation. If a custom subnet is chosen, the selection will override any declaration in the 'Network' field.

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.
If you decide to use configurable options, press on the 'Create Configurable Options' button.

Important: Remember that you may enable either Machine Type configurable option or Custom Machine Series with its sub-options.

Your SSH key must be an RSA key with a key size of either 2048 bits or 4096 bits.
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.
Note: If you disable the 'Show on Order Form' option, a client will not be able to provide SSH Key while placing an order.

This includes 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
   
3. Service actions, including: Start, Stop and Reboot the server
4. Instance details that provide the current status, resources and options set.
5. Network Interface section that informs about the chosen network, private and public IPs.
6. Disk section that gathers all the information about the disk.

At this moment you also have to provide the SSH key. Note that this key should be in one of the OpenSSH standard formats which are supported by API, e.g. ssh-rsa.

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 empty fields:

• Instance ID
• Region
• Zone

The above-mentioned information has to be consistent with the data from your Google Cloud panel. Now, complete these fields as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

The module allows your customers to easily start, stop and reboot their server instance through pressing the appropriate buttons.
It is also possible to download the RDP file and reset the password, just press adequate buttons.

Take a look at the available graphs to get the gist.

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.

Opt for the Open Source version of your Google Cloud Virtual Machines 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.

• Google Cloud → Dashboard → Go to project settings
• IAM and admin → IAM
• Find the user and edit the principal permissions
• Add new role: Owner (Full access to most Google Cloud resources) and save the changes