PUQ Mautic

Docker n8n WHMCS module

A module for WHMCS that uses n8n workflows to deploy the n8n service using Docker.

Description

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Before you start, it is important to read and familiarize yourself with the following articles at this link:
https://doc.puq.info/books/docker-modules

The WHMCS Docker n8n module is designed for automated provisioning and management of n8n instances on a Docker server. It seamlessly integrates with WHMCS, allowing businesses to sell and manage n8n services efficiently.

Key Features

🚀 Automated Container Management

🔒 Service Control & Security

🛠️ Advanced Diagnostic Tools

🌍 Multilingual Support

⚙️ Fully Customizable Workflows

System Requirements

To run the WHMCS Docker n8n module, ensure you have:
✅ WHMCS version 8+
✅ An n8n server for workflow automation
✅ A server with Docker installed for container management

Installation & Setup

1️⃣ Environment Preparation

2️⃣ Module Installation

3️⃣ Workflow Customization

4️⃣ Testing & Deployment

Why Choose This Module?

✅ Seamless automation – Reduces manual work and speeds up service deployment.
✅ Highly customizable – Modify workflows to fit any business model.
✅ User-friendly – Integrated within WHMCS with a simple setup process.

This module makes selling and managing n8n instances through WHMCS easy, automated, and flexible! 🚀

image-1741197788478.png

image-1741198252550.png

image-1741198337588.png

 

What is n8n

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

n8n is an open-source, workflow automation platform designed to simplify and streamline processes by integrating different services, APIs, and applications. It provides an intuitive and customizable way to automate repetitive tasks, connect systems, and create complex workflows without writing a single line of code.

Key Features of n8n:

  1. Open-Source and Self-Hosted
    One of the standout features of n8n is that it is completely open-source. This means that you have full control over your workflows and data. You can host n8n on your own servers or use it in cloud environments, ensuring maximum flexibility and customization to fit your business needs.

  2. Drag-and-Drop Interface
    n8n provides a user-friendly drag-and-drop interface that allows you to create workflows visually. This makes it easy for both technical and non-technical users to design automation processes. With just a few clicks, you can integrate different services, set triggers, and map out complex logic in your workflows.

  3. Wide Integration Support
    n8n supports integrations with over 200 different apps and services, including popular tools like Google Sheets, Slack, GitHub, and Salesforce, as well as hundreds of APIs. This extensive range of integrations means that n8n can be used in virtually any industry, whether it’s automating business processes, synchronizing data, or managing communications.

  4. Powerful Workflow Logic
    n8n allows you to design workflows with powerful logic capabilities. You can use conditional statements, loops, data transformation, and even error handling within your workflows. This enables the creation of sophisticated automations that can handle a wide range of tasks, from simple data transfers to complex multi-step processes.

  5. Self-Hosting and Privacy
    With n8n, you have the option to host your workflows on your own infrastructure, giving you full control over the data and ensuring privacy. This is particularly important for businesses that require compliance with data protection regulations or have sensitive information that should not leave their environment.

  6. Scalability
    n8n can scale with your business. Whether you're running a few simple automations or thousands of complex workflows, n8n’s architecture supports scaling horizontally. You can easily add more workers to handle increased load or deploy it in a distributed setup to ensure high availability.

  7. Version Control and Collaboration
    n8n allows you to use version control for your workflows, making it easy to track changes and collaborate with team members. You can export workflows, share them with others, and keep a history of changes for better collaboration and version management.

  8. Extensible with Custom Nodes
    One of n8n's greatest strengths is its extensibility. If the integrations you need aren’t available out of the box, you can easily create your own custom nodes using JavaScript. This makes n8n adaptable to almost any business need, no matter how niche.

Why Choose n8n?

n8n stands out in the world of workflow automation because it offers a powerful and flexible solution that is both user-friendly and highly customizable. As an open-source tool, n8n provides a level of control and privacy that is hard to find in many commercial automation platforms. Its extensive integrations, scalability, and easy-to-use interface make it suitable for businesses of all sizes, from startups to large enterprises.

Moreover, n8n’s self-hosting option means that you can have full control over your automations, ensuring that your sensitive data stays within your network, which is crucial for businesses with privacy concerns.

Use Cases for n8n

n8n can be used across various industries and use cases, such as:

Conclusion

n8n provides a flexible, powerful, and open-source alternative to commercial workflow automation platforms. With its user-friendly interface, broad integration options, and robust logic capabilities, it enables users to automate tasks across various applications with minimal effort. Whether you need simple automations or complex, multi-step workflows, n8n offers an easy way to automate, save time, and increase efficiency within your business.

Changelog

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
v1.0 Released 17-03-2025

First version

Installation and configuration guide

Installation and configuration guide

Basic concepts and requirements

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Before you start, it is important to read and familiarize yourself with the following articles at this link:
https://doc.puq.info/books/docker-modules

The WHMCS Docker n8n module is part of the WHMCS Docker module series developed by PUQcloud. This module enables service providers to offer n8n Docker containers as a service to their clients, allowing for seamless automation and integration.

The system consists of three core components:

🖥️ WHMCS Module

The core component, installed in WHMCS, manages service provisioning and automation from the WHMCS side.

📡 Debian 12 Server

A server running Debian 12 with the following pre-installed:
✅ Docker – For container management
✅ SQLite3 – For lightweight database operations
✅ Apache2-utils – For authentication and performance enhancements

We have prepared instructions for installing and configuring Docker
https://doc.puq.info/books/docker-modules/page/installing-docker-for-puqcloud-modules

🔗 n8n Server

This server facilitates communication between the WHMCS module and the Docker server, ensuring smooth workflow execution.
To explore n8n’s full potential, visit the official n8n website for documentation, tutorials, and community support.

Key Features & Concepts

⚙️ Workflow Automation

n8n provides a graphical workflow builder, allowing users to automate various tasks, such as:
✔️ Sending notifications
✔️ Configuring firewalls on external routers
✔️ Managing DNS settings
✔️ Custom automation processes tailored to specific needs

🔄 Flexibility & Customization

The module offers personalized settings and supports elastic automation, giving clients full control over their n8n workflows.

 

Installation and configuration guide

WHMCS setup (install/update)

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Module is coded ionCube v13

Supported php version:

To install and update a module, you must perform one and the same action.


1. Download the latest version of the module.

PHP 8.2

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-n8n/php82/PUQ_WHMCS-Docker-n8n-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-n8n/php81/PUQ_WHMCS-Docker-n8n-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-n8n/php74/PUQ_WHMCS-Docker-n8n-latest.zip

All versions are available via link: https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-n8n/

2. Unzip the archive with the module.
unzip PUQ_WHMCS-Docker-n8n-latest.zip
3. Copy and Replace "puqDockerN8N" from "PUQ_WHMCS-Docker-n8n" to "WHMCS_WEB_DIR/modules/servers/"
Installation and configuration guide

Preparing Docker Server

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

To install the Docker server for this module, please follow the instructions at the following link:


https://doc.puq.info/books/docker-modules/page/installing-docker-for-puqcloud-modules
Installation and configuration guide

Setting up n8n workflow

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Overview

The Docker n8n WHMCS module uses a specially designed workflow for n8n to automate deployment processes. The workflow provides an API interface for the module, receives specific commands, and connects via SSH to a server with Docker installed to perform predefined actions.

Prerequisites

Installation Steps

Install the Required Workflow on n8n

You have two options:

Option 1: Use the Latest Version from the n8n Marketplace

Option 2: Manual Installation

n8n Workflow API Backend Setup for WHMCS/WISECP

Configure API Webhook and SSH Access

Modify Template Parameters

In the Parameters block of the template, update the following settings:

image-1741285369145.png

image-1741285412110.png

Do not modify the following technical parameters:

Deploy-docker-compose

In the Deploy-docker-compose element, you have the ability to modify the Docker Compose configuration, which will be generated in the following scenarios:

image-1741875704524.png

image-1741875734754.png

nginx

In the nginx element, you can modify the configuration parameters of the web interface proxy server.

image-1741875960357.png

image-1741875978450.png

Bash Scripts

Management of Docker containers and all related procedures on the server is carried out by executing Bash scripts generated in n8n. These scripts return either a JSON response or a string.

image-1741876353319.png

 

 

Installation and configuration guide

Add server

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
Add a new server to the system WHMCS.
System Settings->Servers->Add New Server

image-1741287291552.png

Attention: Important Information

The hostname field represents the actual domain of the server running Docker and must match the server_domain parameter in the n8n workflow. If they do not match, communication will not function correctly.
Additionally, this domain must be configured so that all its subdomains resolve to the IP address of the server running Docker.

image-1741287929855.png

In the Server Details section, select the "PUQ Docker n8n" module and enter the correct username and password for the API endpoint in the n8n workflow.

Additionally, in the Access Hash field, insert the URL of the API entry point for the n8n workflow.

image-1741288408583.png

image-1741288463418.png

 

Installation and configuration guide

Product Configuration

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
Add new product to WHMCS
System Settings->Products/Services->Create a New Product

In the Module settings section, select the "PUQ Docker n8n" module

image-1741887543405.png

Installation and configuration guide

Metric Billing

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

To bill certain metrics separately, you can use the standard WHMCS Metric Billing mechanism.

To configure it, you need to enable the required metrics and set the desired prices. Metrics work based on the standard WHMCS mechanism, the description of which can be found here:

https://docs.whmcs.com/products/configuration-options/usage-billing/

image-1741888208248.png

image-1741888239156.png

Installation and configuration guide

Email Template (puqDockerN8N Welcome Email)

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

image-1741280463072.png

Subject: 

n8n Order Information

Body:

Dear {$client_name},

Your order has been accepted for implementation.

Product/Service: {$service_product_name}
Payment Method: {$service_payment_method}
Amount: {$service_recurring_amount}
Billing Cycle: {$service_billing_cycle}
Next Due Date: {$service_next_due_date}


The installation and setup of your n8n instance is in progress.
Within the next 4 minutes, you will be able to use your n8n instance.

Upon your first login, you will need to create an account.

Here is the link to your n8n server.

https://{$service_domain}/
Thank you for choosing us.

{$signature}

image-1741280532648.png

 

 

Installation and configuration guide

Email Template (puqDockerN8N Update Email)

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

image-1741280642313.png

Subject: 

n8n Update Information

Body:

Dear {$client_name},

Your instance is currently being updated.
You will be able to use your n8n server again within 3 minutes.

Here is the link to your n8n server.

https://{$service_domain}/
Thank you for choosing us.

{$signature}

image-1741280591071.png

 

Installation and configuration guide

Email Template (puqDockerN8N Notification disk limit)

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

image-1741887789149.png

Subject: 

Disk space usage {$disk_used_percentage}%

Body:

Dear {$client_name},

We want to inform you that your n8n service is running low on disk space. 
Please take action to prevent service interruptions.

Service Details:

Product/Service: {$service_product_name}
Domain: {$service_domain}
Total Disk Space: {$disk_total}
Used Disk Space: {$disk_used} ({$disk_used_percentage}%)
Consider freeing up space or upgrading your plan if needed.

{$signature}

image-1741887889159.png

 

Admin Area

Admin Area

Product Information

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Admin Panel – Container Management Overview

The admin panel is structured into two main sections with additional control buttons for container management.

Control Buttons

Container Status & Resource Monitoring

Application Information

 

image-1741294164701.png

image-1741294473126.png

Metric Statistics

image-1741881751238.png

Client Area

Client Area

Home screen

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

Client Area Overview – Logical Structure

The main screen of the client area is divided into three logical sections:

  1. Navigation Block

    • "Go to n8n": Direct link to access the application.
    • "User Manual": Opens the official documentation or user guide.

  2. Resource Usage Block

    • Displays real-time statistics on container resource usage:
      • CPU Usage: Number of allocated CPUs and current load.
      • Memory Usage: RAM consumption, helping clients understand available capacity.
      • Disk Usage: Storage consumption within the container.
    • This section is crucial for users to monitor performance and determine whether they need to upgrade their package.

  3. Application Information & Controls

    • Application Version: Displays the installed software version.
    • Owner Information: Indicates the primary administrator of the application.
    • User List: Shows active users associated with the instance.
    • Reset Password Button: Allows the client to reset the administrator password for the application.

This clear structure ensures that users have quick access to their application, real-time monitoring of resource usage, and essential management functions in one place.


image-1741293825976.png

image-1741294118196.png

Client Area

IP Access Control

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

In the client area, the client can configure access to their resource by entering allowed IP addresses in the appropriate section on the Restrict by IP page.

If no IP addresses are specified, access is open to all IP addresses.

image-1741881894370.png

Client Area

Reinstall

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

The client has the option to fully reinstall the application, which will result in complete data loss.

This action can be performed on the Reinstall page, which also includes protection against accidental reinstallation.

image-1741882286068.png

Client Area

Metrics

Docker n8n module WHMCS 

 Order now | Download | FAQ | n8n

If you use metrics for application traffic billing, the Metrics tab will display the usage statistics for the metrics.

image-1741886800030.png