Portainer Docker Containers For WHMCS

About Portainer Docker Containers For WHMCS

Portainer Docker Containers For WHMCS is a module that connects your WHMCS system with Portainer, allowing you to sell and manage Docker containers just like traditional hosting products. It automates the deployment process, so containers are created, configured, and assigned to clients instantly upon purchase. Clients can control their containers directly from the WHMCS client area, including start, stop, restart actions, viewing logs, accessing the console, and more. You can also enable "App Templates" to let clients reinstall their stack using predefined configurations.

• Addon Module Features:

✔ ffffff

✔ fffffffffff

✔ f

✔ Set Failure Count To Trigger Notification

• Client Area:

✔ Create Monitoring Checks For Allowed Services Within Specified Limits:

✔ Set Server Monitoring Check Limit

• General Info:

✔ Multi-Language Support With Custom Translations Tool

✔ Supports PHP 8.4 Back To PHP 8.1

✔ Supports WHMCS V8.13 Back To WHMCS V8.10

✔ Requires ionCube Loader V14 Or Later

✔ Easy Module Upgrade To Open Source Version

Installation And Confiuration

This tutorial will show you how to successfully install and configure Portainer Docker Containers For WHMCS. We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.

2. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this.

3. When you install Portainer Docker Containers For WHMCS for the first time you have to rename 'license_RENAME.php' file. The file is located in 'modules/addons/PortainerDockerContainers/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

4. In order to configure your license key, you have to edit the previously renamed 'license.php' file. 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'.

5. Now, set up the 'storage' folder as recursively writable. This folder is available at '/yourWHMCS/modules/addons/PortainerDockerContainers/'.

Addon Activation

5. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Portainer Docker Containers' and press the 'Activate' button.

6. In the next step, you need to permit access to this module. To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

8. You have just successfully installed Portainer Docker Containers For WHMCS! You can access your module under 'Addons' → 'Portainer Docker Containers'. Read the guide provided on the 'Dashboard' or continue with this documentation.

Configuration of Server

12. Now, log in to your WHMCS and proceed to 'System Settings' → 'Servers' and press 'Add New Server'.

13. Fill in the Name, Hostname, and IP Address fields at the top (both Hostname and IP Address are required to proceed). In the Server Details section: Set Module to 'Portainer Docker Containers' Enter your Portainer API key in the Password field (use an admin account token). Click Test Connection to ensure proper communication with the Portainer instance. Click the Configure button to select your desired environment (Portainer endpoint). Note: The environment defines all core settings, such as available resources (CPU, RAM, GPU) and what container or stack templates will be used. These are configured directly in Portainer. In the WHMCS module, you only choose from existing environments. After selecting the environment, the Access Hash will be filled in automatically. If your Portainer server uses SSL, ensure the Secure' checkbox is enabled. You can also enable the Override with Custom Port option and enter your custom Portainer API port. Finally, adjust SSO Access Control if needed, then click Save Changes.

14. It is time to create a server group. To do so, click on 'Create Server Group'.

15. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'.

Configuration of Product

16. In order to create and configure a product, go to 'System Settings' → 'Products/Services'. Click on 'Create a New Group' .

17. Enter a product group name and press 'Save Changes'.

18. When you have a product group, you can create your product. To create a product click on 'Create a New Product' .

19. Afterward, choose your product group, module and type from the dropdown menus, enter your product name and press 'Continue'. 'Product Type' should be set to 'Shared Hosting'.

20. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu. The module should automatically save and reload settings. If not, click on 'Save Changes' manually.

21. Proceed to Configuration. Default Instance Name – Enter the default name to be used when creating a new stack or container. The name must contain only lowercase letters, digits, hyphens (-), or underscores (_). Available variables: {$domain}, {$client.id}, {$service.id}, {$order.id}, {$random}. If left empty, the domain name will be used. Default Username – Enter the default username to be used when creating a new user. Available variables: {$domain}, {$client.id}, {$service.id}, {$order.id}, {$random}. If left empty, the domain name will be used. Open Container Console in New Window – Enable this option to open the container console in a new window when the feature is available in the client area.

22. Proceed with 'App Template Configuration'. App Templates Configuration - To create instances based on stack or container applications, you must first configure the App Templates in the module's addon. Once your applications and groups are set up there, you can select the desired application in the product's Module Settings tab to be used during instance creation. Please refer to the App Templates section of the documentation for detailed setup instructions. Default Application Group - group of applications allowed for reinstalls, see the groups section. Default Application - default application to be installed on the VPS, see the applications section.

File:PDC 16 1.png

23. Set up container limits: Memory Reservation [MB] - Specify the amount of memory (in MB) reserved for the container. Set to 0 for no reservation. Memory Limit [MB] - Set the maximum amount of memory (in MB) the container can use. Use 0 for unlimited. CPU Limit [Cores] - Set the maximum number of CPU cores available to the container. Use 0 for unlimited. Alternatively, you can use configurable options to allow clients to define these limits at checkout.

24. Next, select the features that will be available in the client area. Container Details – Show basic information about the container, such as status, IP address, and resource usage. Stack Details – Display information related to the assigned stack configuration. Start – Allow clients to start their container. Stop – Allow clients to stop their container. Restart – Allow clients to restart their container. App Templates – Enable access to predefined application templates for quick reinstall. Environment Variables – Allow clients to view or manage container environment variables. Published Ports – Show mapped ports between the host and the container. Container Logs – Provide access to real-time container logs. Console – Allow access to the container's interactive console. Graph – Show performance graphs such as CPU, memory, and network usage. Assigned Containers – Display a list of all containers assigned to the client. Action Logs – Provide a history of actions performed on the container (e.g. start, stop, reinstall).

25. Select the features that will be available in the admin area. These options define what information and controls admins will see within the WHMCS service management page: Service Actions – Perform start, stop, or restart actions directly from the admin area. Stack Details – View the full configuration and status of the assigned stack. Assigned Containers – Display all containers linked to the service. Container Details – Show detailed information about the container, such as IP address, image, and resource usage. Published Ports – View the port mappings for the container. Environment Variables – View environment variables set for the container. Container Logs – Access logs generated by the container. Graphs – Display real-time resource usage graphs (CPU, RAM, network, disk I/O). Action Logs – Review all actions performed on the container or stack from within WHMCS.

File:PDC 17 1.png

25. At the end of the configuration process, you can decide whether to generate configurable options for the product. Configurable options allow clients to customize container parameters individually during the order process. If no configurable options are defined, the fixed values set in the product configuration will be used instead. Available Configurable Options: app – Application memory_reservation – Memory Reservation memory_limit – Memory Limit max_cpu_usage – CPU Limit

Management

Portainer Docker Containers For WHMCS allows your clients to manage and monitor their Docker containers directly from the WHMCS client area. In this short guide, you'll learn about the module's key features and how to configure them for both client and admin use.

Module Addon

The module addon is the central place for all administrative setup and management. Here, you can register products supported by the module, manage Docker templates, and access various utilities such as the template queue, translation manager, and module logs.

App Templates

The App Templates section allows you to manage Docker-based applications that clients can deploy to their containers or stacks directly from the client area. Templates are divided into two types, available under separate tabs: Container Applications and Stack Applications. Use the interface to import, edit, group, and assign application templates to products.

Applications

Before using App Templates, please review the built-in guide accessible from the Additional Actions button → Options → Collapse Guide. This section allows you to load available templates from your connected Portainer environment and manage them from within WHMCS.

Switch between available categories: Container Applications or Stack Applications using the tabs at the top.

Click the refresh icon to import or update the list of templates from Portainer.

Once templates are imported, you can use action buttons to edit, duplicate, or delete them. Mass actions are also available for bulk management.

Groups

With the templates ready, all that is left is to gather them into groups and include said groups into products. Navigate to 'App Templates' → 'Groups' and click on the 'Create' button.

Read the information, then provide the group with: Name Description Items to include

You can use the action button and the mass action function to edit and delete template groups.

To make application templates available to clients, assign a group in the product’s App Templates Configuration section using the Default Application Group setting.

Ensure the App Templates feature is enabled under Client Area Features for that product.

Advanced Configuration

Advanced configuration of App Templates allows in-depth management of your container and stack application templates. Admins can manually create and edit applications, define their runtime behavior, set default values, and customize input fields using setting details. See the examples below to understand the most important options.

Manually Adding Applications

You can add individual container or stack applications manually without syncing all templates from Portainer. 1. Navigate to App Templates → Applications, then click Create to add a new template.

2. Fill in the basic details, such as: Name – Display name for the application (e.g., Caddy, Redis). Description – Optional. Short info about what the application does. Status – Set to "Active" if the template should be available for use. Image – Docker image used to deploy this template (e.g., `caddy:latest`). Click Submit to save.

Defining Application Settings

After saving, go to the Setting Details panel to configure how the template behaves during deployment. Click Create or use the pencil icon to edit an existing setting.

File:VT 19 14 c.png

When editing or adding a setting, you'll need to define: Name – Internal identifier (e.g., `template_id`, `terminal_command`, `labels`) Field Type – Defines how the field will appear (Text, Select, etc.) Default Value – Used as the base value passed to Portainer Validation – Optional. Laravel-style validation rules (e.g., `required`) Visibility – If enabled, clients will see and can edit this field in the client area

File:VT 19 14 c.png

Scripting Support (Optional)

EYou can inject startup scripts or configuration commands during container deployment via a dedicated setting. This is useful for automated setup of services or software in the container. Use Smarty variables (e.g., `{$service.domain}`, `{$password}`) for dynamic content. To make the script editable by clients, enable the Visibility toggle.

See the list below to learn how to set up the setting. 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.

If visibility is enabled, the script input will appear before deployment. If disabled, the script will still execute, but the client won't see or modify it.

File:PDC 19 14 9.png

Media Library

The media library allows you to upload images for use elsewhere in the module by admins and clients. To upload a new picture, click on the 'Upload Image' button.

File:PDC 19 20.png

You can delete images one by one by clicking on them. To delete all images at once, use the additional action button.

File:PDC 19 21.png

Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon. Its user-friendly design makes managing various language file tweaks a smooth and efficient process. Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

File:PDC 19 22.png

Logs

The 'Logs' section under the 'Other' tab is where the module logs are stored. You can filter the module logs by type with the 'Show' buttons: Critical Error Notice All (Total) All information on Logs can be found in the dedicated to logs article, you will find it here: https://www.docs.modulesgarden.com/Logs.

File:PDC 19 23.png

Dashboard

The 'Dashboard' provides information and statistics related to the functions of the module. At the top, you will find a condensed setup guide, presenting the same information as this documentation.

After familiarizing yourself with the guide, you can opt to hide it under 'Additional Actions' → 'Settings'.

File:PDC 9 1.png

Monitor total .........

All table

Ordering

Oredr page summary

File:PDC order.png

Admin Area

Admin Area product page view:

File:PDC aa.png

Client Area

With Portainer Docker Containers For WHMCS, clients can fully manage their Docker containers and stacks directly from the WHMCS client area. They can view service information, monitor performance, execute key actions, and deploy applications — all without needing direct access to Portainer. Available features depend on the options enabled in the product configuration.

File:PDC 24.png

Service Actions Clients can quickly start, stop, or restart their containers using dedicated control buttons.

File:PDC 25.png

Stack Details Display essential stack information including name, current status, and exposed environment variables.

Assigned Containers List all containers associated with the client’s stack. Each entry includes the container name, status, image, IP address, and published ports. Clicking a container entry opens a detailed view with technical and performance data.

Action Logs

The Action Logs section tracks all actions performed on the container or stack, such as starting, stopping, reinstallation, and template deployments. This history helps clients verify activity and troubleshoot potential issues.

File:PDC 23 1.png

App Templates

The App Templates section allows clients to reinstall their container or stack using a predefined application template. This provides a fast and simple way to deploy fully configured environments such as databases, web servers, or development tools. Important: Reinstalling an application will permanently remove any existing container data.

File:PDC 23 1.png

Container Details View

Clicking on a container from the stack view opens a dedicated detail panel with full technical insight. The view is divided into multiple sections for clarity and easier access to specific information. This is also how a 'Container-type product looks on the main CA page.

File:PDC 23 0.png

Service Actions

Use the same action buttons — Start, Stop, and Restart — directly within the container view for instant control.

Container Details

General Information Status – Shows whether the container is running or stopped Image – Docker image used (e.g., `timescale/timescaledb-ha:pg14-latest`) Network Mode – The Docker network connected to the container Resource Usage CPU Usage – Real-time CPU load Memory Usage – Live memory consumption in MB Network Usage – Inbound/outbound traffic IO Usage – Disk read/write metrics Networking IP Address – Internal container IP address MAC Address – Virtual MAC assigned to the container (if available)

File:PDC container details.png

Published Ports – Mappings between private and public ports, including protocol types

File:PDC container details.png

Environment Variables All environment variables currently assigned to the container are displayed, including sensitive configuration data and service paths.

File:PDC container details.png

Service Management

If enabled in the product settings, clients will also have access to additional tools: Container Logs – Live log output of the container’s stdout and stderr

File:PDC container details.png

Console – Web-based terminal access for direct container management

File:PDC container details.png

Graphs – Real-time resource graphs including CPU, memory, network, and I/O statistics

File:PDC container details.png

Tips

1. If you

Update Instructions

An essential guidance through the process of updating the module is offered here. 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.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability? There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment. 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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.