Deploy Docker n8n, API backend for WHMCS/WISECP

Setting up n8n workflow

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

• You must have your own n8n server.
• Alternatively, you can use the official n8n cloud installations available at: n8n Official Site

Installation Steps

Install the Required Workflow on n8n

You have two options:

Option 1: Use the Latest Version from the n8n Marketplace

• The latest workflow templates for our modules are available on the official n8n marketplace.
• Visit our profile to access all available templates: PUQcloud on n8n

Option 2: Manual Installation

• Each module version comes with a workflow template file.
  
• You need to manually import this template into your n8n server.
  

n8n Workflow API Backend Setup for WHMCS/WISECP

Configure API Webhook and SSH Access

• Create a Basic Auth Credential for the Webhook API Block in n8n.
  

• Create an SSH Credential for accessing a server with Docker installed.
  

Modify Template Parameters

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

• server_domain – Must match the domain of the WHMCS/WISECP Docker server.
• clients_dir – Directory where user data related to Docker and disks will be stored.
• mount_dir – Default mount point for the container disk (recommended not to change).

Do not modify the following technical parameters:

• screen_left
• screen_right

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:

• When the service is created
• When the service is unlocked
• When the service is updated

nginx

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

• The main section allows you to add custom parameters to the server block in the proxy server configuration file.
• The main_location section contains settings that will be added to the location / block of the proxy server configuration. Here, you can define custom headers and other parameters specific to the root location.

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.

• All scripts are located in elements directly connected to the SSH element.
• You have full control over any script and can modify or execute it as needed.