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

The content of the package to upload should look like this.

The file is located in 'modules/addons/PortainerDockerContainers/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

Enter your license key between 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/addons/PortainerDockerContainers/'.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Portainer Docker Containers' and press the 'Activate' button.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

You can access your module under 'Addons' → 'Portainer Docker Containers'.
Read the guide provided on the 'Dashboard' or continue with this documentation.

In this brief guide, we will introduce the module’s capabilities and show you how to make the most of its features.

It allows you to add products to the module, enabling the creation of checks for services associated with those products.
It also features several management tools like the queue, translations tool and module logs.

Prepare templates in the 'Applications' tab and gather them into groups in the 'Groups' tab.
For clients to be able to install templates on their VPS, their product has to include an 'Application Group' and allow 'App Templates' in the client area.

You can change the settings and have the guide collapsed by default. Clicking on the 'Additional Actions' button, select 'Options' and 'Collapse Guide'.

You can also use the mass action buttons to manage multiple templates at once.

Navigate to 'App Templates' → 'Groups' and click on the 'Create' button.

• Name
• Description
• Items to include

Note: Keep in mind that Vultr includes Windows licenses (Core and Standard) in their Plans and charges a monthly fee for them.
Since this will affect the Plan price, we recommend not including Windows with other systems in one product.

Find the 'App Templates Configuration' section and 'Default Application Group' field.
Include a chosen group for the product.

See the examples below to learn about the most important options.

1. Navigate to 'App Templates' → 'Applications' and click on 'Create'.

See the official official Vultr documentation too learn how.
Make sure to include your API Key, the request looks like this:

curl "https://api.vultr.com/v2/applications" \
 -X GET \
 -H "Authorization: Bearer ${VULTR_API_KEY}"

Example result:

{
"applications": [
{
"id": 1,
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"type": "one-click",
"vendor": "vultr",
"image_id": ""
}

For example 'LEMP' from:

"name": "LEMP",

Note: If you include a 'name' setting detail (see step 4) with the name from the request as its value, you can safely rename the application to something else here.

In our case it is:

"id": 1,

If an application supports scripts, the responsible setting will always be added automatically.
To include a script, edit the setting by clicking on the 'Edit' button next to it.

• Name - do not change this value, this is the setting identifier.
• Field Type - if the 'Visibility' setting is toggled on, this field decides the type of field, we recommend leaving it as is.
• Default Value - this is where you include your script. If 'Visibility' is toggled on, this will be the default value that clients can modify.
  Note: Use the merge field list on the right for reference.
• Validation - optionally, provide Laravel validation rules like 'required'.
• Visibility - this will allow the client to modify the script before installation.

To see how clients can add and monitor checks for their services see the Client Area section.
To add checks as an admin, navigate to the 'Checks' section of the module and click on the 'Create Check' button.

• Name - provide a name for the check.
• Status - select the initial status of the check, this can be changed later.
• Verification Interval - decide how often the check should be performed (in minutes).
• Failure Count for Notification - indicates how many checks need to fail before a notification is sent.
• Notifications Delay - set the notification delay, in minutes, for sending notifications when checks fail.
• Monitored Service - select the service that will be checked.
• Type of Performed Check - pick the check type.
  • cURL Check - an HTTP GET request is sent to a server to retrieve data and check its availability.
    • Request URL - provide a URL that will return a code upon a GET request.
    • Response Code - include the expected HTTP response code.
  • ICMP Ping Check - an ICMP ping is sent to a specific IP address to test if the server is reachable.
    • IP Address - provide the IP address for the check.
  • Socket Ping Check - a connection attempt is made to a specific IP address and port to check if the service is running and accessible.
    Important: This ping type requires specific configuration, see the Tips section for details.
    • IP Address - provide the IP address for the check.
  • Port Connect - a connection attempt is made to a specific IP address and port using the TCP protocol to verify if the service on the specified port is running and accessible.
    • Allow Custom IP Address - allow the client to enter a custom IP address instead of selecting from assigned ones.
• Notification Type - select the notification type.
  • Email Notification - email messages will be sent out after the threshold for failed checks is exceeded.
    • Email Template for Failed Checks - decide which email template will be used when the failed check threshold is exceeded.
      The default email template is named 'Server Monitoring - failed checks alert', it includes merge fields and can be freely edited.
    • Email Template for Service Recovery - decide which email template will be used when the service has recovered.
      The default email template is named 'Server Monitoring - service unreachable', it includes merge fields and can be freely edited.
    • Notification Recipients - select where to send the notification.
  • SMS Notification - enable SMS notifications to keep clients informed of monitoring events.
    Note: SMS notifications require SMS Center For WHMCS.
    • Message Template for Failed Checks - choose the SMS template used to notify clients when a check fails.
    • Message Template for Service Recovery - choose the SMS template used to notify clients when a service recovers following downtime.
    • API Execution Admin - select the admin account that will execute API requests.
    • SMS Recipients - Provide the phone numbers to which the notification will be sent. Use a valid international format, such as +XX XXXXXXXXXX or +XX.XXXXXXXXX, where 'XX' is the country code.

• The result of the check
• Its message
• Its date

Note that clients will not be able to see messages when checking logs in the client area.

It allows you to view and interact with task details, including task IDs, statuses, and related items.
You can filter tasks, execute actions like deleting or running tasks, and even use mass actions for bulk operations.
For detailed guidance on using this tool, please refer to the dedicated article available here.

For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

For detailed guidance on using this tool, check its dedicated article, which is available here.

At the top, you will find a condensed setup guide, presenting the same information as this documentation.

• Check Results from the Last 24 Hours
• Check Results from the Last 7 Days
• Check Results from the Last 30 Days
• Total Check Results

• Check ID
• Check Name
• Related Service
• Check Type
• Status

The basic client area integration allows them to create and monitor checks for their service, within restrictions opposed by the admin.
To add a new check, click on the 'Create Check' button.

• Name - provide a name for the check.
• Status - set the initial status of the check, it can be toggled off and on later as well.
• Verification Interval - set how often the check should be performed (in minutes).
• Failure Count for Notification - set how many checks with the failed verification are needed to send a notification.
• Type of Performed Check - select the type of the check.
• IP Address - select/provide an IP address to be checked.
• Notification Type - select the type of the notification.
• Notification Recipients - select where the notification should be sent.

Consider disabling a check with the 'Status' toggle before deleting it for good.

• Check Name
• Check Type
• Check Result
• Check Date

 sudo php -q /your_whmcs/modules/addons/ServerMonitoring/cron/cron.php checks:run 

serverMonitoring|Server Monitoring Tool

serverMonitoringChecksLimit|Checks Limit

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 Server Monitoring 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.