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](https://doc.puq.info/books/docker-modules)
The **WHMCS Docker Immich module** is part of the **WHMCS Docker module series** developed by **PUQcloud**. This module enables service providers to offer **Immich 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 We have prepared instructions for installing and configuring Docker [https://doc.puq.info/books/docker-modules/page/installing-docker-for-puqcloud-modules](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](https://n8n.io/)** 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. # WHMCS setup (install/update) ### Docker Immich module **[WHMCS](https://puqcloud.com/link.php?id=77)** ##### [Order now](https://puqcloud.com/whmcs-module-docker-immich.php) | [Download](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/) | [FAQ](https://faq.puqcloud.com/) | [n8n](https://puqcloud.com/link.php?id=117)**Module is coded ionCube v13**
Supported php version: - php 7.4 WHMCS 8.11.0 - - php 8.1 WHMCS 8.11.0 + - php 8.2 WHMCS 8.11.0 +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 ```Powershell wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/php82/PUQ_WHMCS-Docker-Immich-latest.zip ``` PHP 8.1 ```Powershell wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/php81/PUQ_WHMCS-Docker-Immich-latest.zip ``` PHP 7.4 ```Powershell wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/php74/PUQ_WHMCS-Docker-Immich-latest.zip ```All versions are available via link: [https://download.puqcloud.com/WHMCS/servers/PUQ\_WHMCS-Docker-Immich/](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/)
##### 2. Unzip the archive with the module. ```Powershell unzip PUQ_WHMCS-Docker-Immich-latest.zip ``` ##### 3. Copy and Replace "puqDockerImmich" from "PUQ\_WHMCS-Docker-Immich" to "WHMCS\_WEB\_DIR/modules/servers/" # Preparing Docker Server ### Docker Immich module **[WHMCS](https://puqcloud.com/link.php?id=77)** ##### [Order now](https://puqcloud.com/whmcs-module-docker-immich.php) | [Download](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/) | [FAQ](https://faq.puqcloud.com/) | [n8n](https://puqcloud.com/link.php?id=117) ### 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](https://doc.puq.info/books/docker-modules/page/installing-docker-for-puqcloud-modules) # Setting up n8n workflow ### Docker Immich module **[WHMCS](https://puqcloud.com/link.php?id=77)** ##### [Order now](https://puqcloud.com/whmcs-module-docker-immich.php) | [Download](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/) | [FAQ](https://faq.puqcloud.com/) | [n8n](https://puqcloud.com/link.php?id=117) ## Overview The **Docker Immich 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](https://n8n.partnerlinks.io/o692v7cg297k) ## 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](https://n8n.io/creators/puqcloud/) #### **Option 2: Manual Installation** - Each module version comes with a workflow template file. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742323788556.png) - You need to manually import this template into your n8n server. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741284912356.png) ## 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. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742323836025.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742323899841.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742323927094.png) - Create an **SSH Credential** for accessing a server with Docker installed. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741285118412.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741285147192.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741285198822.png) ### Modify Template Parameters In the **Parameters** block of the template, update the following settings: [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742323964634.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741285412110.png) - `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 [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741875704524.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742324015958.png) ### **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. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741875960357.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742324044762.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. - 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. [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741876353319.png) # Add server ### Docker Immich module **[WHMCS](https://puqcloud.com/link.php?id=77)** ##### [Order now](https://puqcloud.com/whmcs-module-docker-immich.php) | [Download](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/) | [FAQ](https://faq.puqcloud.com/) | [n8n](https://puqcloud.com/link.php?id=117) ##### Add a new server to the system WHMCS. ``` System Settings->Servers->Add New Server ``` - Enter the correct **Name** and **Hostname** [](https://doc.puq.info/uploads/images/gallery/2025-03/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.
[](https://doc.puq.info/uploads/images/gallery/2025-03/image-1741287929855.png) In the **Server Details** section, select the **"PUQ Docker Immich"** 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.
[](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742324235831.png) [](https://doc.puq.info/uploads/images/gallery/2025-03/image-1742324306086.png) # Product Configuration ### Docker Immich module **[WHMCS](https://puqcloud.com/link.php?id=77)** ##### [Order now](https://puqcloud.com/whmcs-module-docker-immich.php) | [Download](https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Docker-Immich/) | [FAQ](https://faq.puqcloud.com/) | [n8n](https://puqcloud.com/link.php?id=117) ##### Add new product to WHMCS ``` System Settings->Products/Services->Create a New Product ``` In the **Module settings** section, select the **"PUQ Docker Immich"** module - **License key ā** A pre-purchased license key for the **"PUQ Docker Immich"** module. For the module to work correctly, the key must be active - **Disk space** ā defines the allocated disk size for the Docker container. - **CPU** ā sets the CPU usage limit for the Docker container. - **RAM** ā specifies the amount of RAM allocated to the Docker container. - **Link to instruction** ā URL to a guide that will be displayed in the client panel if provided. - **Main domain** ā defines the primary domain for the web interface of the application. If not set, the main domain will be taken from the **hostname** parameter in the server settings. - **Subdomain** ā a personal subdomain assigned to each service. If left empty or if the subdomain is already taken, it will be automatically generated in the format **{user\_id}-{service\_id}**. - ### Supported Macros for **App Subdomain**: - **{user\_id}** ā Client ID - **{service\_id}** ā Service ID - **{random\_digit\_x}** ā Random number (x defines the length) - **{random\_letter\_x}** ā Random letter (x defines the length) - **{unixtime}** ā Unix timestamp - **{year}, {month}, {day}, {hour}, {minute}, {second}** ā Date and time values