PUQ Mautic

Installation and Configuration Guide

Step-by-step instructions for installing, configuring, and setting up the Synology WHMCS module, including Synology DSM preparation, WHMCS integration, email templates, and product configuration.

WHMCS setup (install/update)

Synology module WHMCS

Order now | Download | Community

System requirements

Requirement Minimum version
PHP 7.4 or higher (7.4 / 8.1 / 8.2)
WHMCS 8.x or higher
ionCube Loader v13 or newer (v14, v15)
Synology DSM 7.x or higher

Note: The module uses ionCube encoding. Make sure ionCube Loader is installed and active on your server.

Backward compatibility

This module supports older PHP versions and older WHMCS versions for maximum compatibility with existing hosting environments. PHP-version-specific builds are provided:

Each build is encoded with the appropriate ionCube version for the target PHP runtime.

Download

The module can be ordered and downloaded from PUQ Cloud:

# PHP 7.4
wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php74/PUQ_WHMCS-Synology-latest.zip

# PHP 8.1
wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php81/PUQ_WHMCS-Synology-latest.zip

# PHP 8.2
wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php82/PUQ_WHMCS-Synology-latest.zip

After downloading, extract the archive:

unzip PUQ_WHMCS-Synology-latest.zip

Installation

Step 1: Upload files

Extract the module archive and copy the puqSynology directory to the WHMCS servers module directory:

WHMCS_WEB_DIR/modules/servers/puqSynology

Step 2: Add server

Navigate to System Settings → Servers → Add New Server:

  1. Enter the correct Name and Hostname
  2. In Server Details, select the PUQ Synology module
  3. Enter valid Synology DSM credentials (username and password)
  4. Click Test connection to verify

Step 3: Create product

Navigate to System Settings → Products/Services → Create a New Product:

  1. Select the PUQ Synology module in the Module settings section
  2. Configure the product parameters

Update

Step 1: Backup

Before updating, it is recommended to back up:

Step 2: Upload new files

Download and extract the new version, then overwrite all files in:

WHMCS_WEB_DIR/modules/servers/puqSynology/

Step 3: Verification

  1. Log in to the WHMCS admin panel
  2. Check the module is functioning correctly
  3. Verify product settings

Important (v3.0): Product reconfiguration is required after updating to version 3.0.

Synology part setup guide

Synology module WHMCS

Order now | Download | Community

Here are the initial steps of configuring Synology devices to prepare them for use with the WHMCS module.

Note: At the beginning, you should prepare the appropriate domain with the correct DNS entries so that you can generate a correct SSL certificate for Your Synology NAS server.

1. Generate an SSL certificate for your domain.

Connect the certificate for all services that will be used in the server.(FTPS, System, Synology Drive, etc...)

04-synology-setup-1.png

2. Make sure the partition is formatted in BTRFS

07-synology-setup-4.png

3. Enable the user's home folder.

08-synology-setup-5.png

4. Enable all necessary file services (ie: FTP, FTPS, SFTP, etc.).

09-synology-setup-6.png

5. Create user groups with the necessary quotas and permissions.

05-synology-setup-2.png

06-synology-setup-3.png

WHMCS part setup guide

Synology module WHMCS

Order now | Download | Community
1. Download the latest version of the module

Choose the build that matches your server's PHP version:

PHP 8.2

wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php82/PUQ_WHMCS-Synology-latest.zip

PHP 8.1

wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php81/PUQ_WHMCS-Synology-latest.zip

PHP 7.4

wget https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/php74/PUQ_WHMCS-Synology-latest.zip

Note: All versions are available here: https://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Synology/

2. Unzip the archive with the module
unzip PUQ_WHMCS-Synology-latest.zip
3. Copy "puqSynology" to "WHMCS_WEB_DIR/modules/servers/"
4. Add the Synology NAS server in WHMCS
System Settings -> Servers -> Add New Server

10-add-server-1.png

11-add-server-2.png

Warning: The ACCESS HASH field is used to store the server access key and is updated automatically — do not edit it manually.

For more details, see Add server (Synology NAS).

5. Create the product
System Settings -> Products/Services -> Create a New Product

In the Module Settings section, select the PUQ Synology module and the Server Group that contains your Synology server, then click Save Changes to load the configuration panel.

14-product-configuration-overview.png

Every setting in this panel (License key, Disk, Synology group, Notifications, History, Client Area and User rules) is described in detail on the Product Configuration page.

Email Template (puqSynology Notification disk limit)

Synology module WHMCS

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

12-email-template-1.png

Subject:

Disk space usage {$disk_used_percentage} % - {$username}

Body:

Dear {$client_name},

This letter informs you that the disk space usage limit is coming to an end.

Product/Service: {$service_product_name}
Due Date: {$service_next_due_date}

Username: {$username}

Disk limit: {$disk_limit_bytes*$unit_coefficient} {$unit}
Disk used: {$disk_used_unit} {$unit} ({$disk_used_percentage} %)
Disk free: {$disk_free_unit} {$unit} ({$disk_free_percentage} %)

{$signature}

13-email-template-2.png

Add server (Synology NAS)

Synology module WHMCS

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

10-add-server-1.png

11-add-server-2.png

Warning: WARNING: ACCESS HASH field Used to store the access key to the server and is updated automatically.

Product Configuration

Synology module WHMCS

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

In the Module Settings section, select the PUQ Synology module and the Server Group that contains your Synology server, then click Save Changes. The module then renders its modern configuration panel.

14-product-configuration-overview.png

Note: Select the Server Group and save the product first — the Synology group drop-down (in the Disk section) is populated live from the server assigned to that group.

At the top of the panel:

Disk

20-product-config-disk.png

Note: Display only. The disk size/unit are shown to the client in the client area (and used for the usage-percentage chart and notifications). They do not enforce a limit on Synology. The real quota/permission limits must be configured on the Synology group selected here (Control Panel → User & Group → Group → Quota).

Notifications

21-product-config-notifications.png

History

22-product-config-history.png

Client Area

23-product-config-client-area.png

User

24-product-config-user.png