PUQ Mautic

MinIO S3 WHMCS module

The module allows the company to offer its customers the possibility of managing data storage compatible with S3 object storage using the MinIO S3 solution.

Description

MinIO S3 module WHMCS 

 Order now | Download | FAQ

The module allows the company to offer its customers the possibility of managing data storage compatible with S3 object storage using the MinIO S3 solution.

The module requires a fully configured MinIO server to work. The module does not assist in the creation of such a server in any way.

Functions:

Available options in the admin panel:

Available options in the client panel:

WHMCS: 8 +

MinIO: RELEASE.2024-06-26T01-06-18Z +

 

image-1717715917516.png

image-1677935455983.png

image-1677935455999.png

 

 

 

Changelog

MinIO S3 module WHMCS 

 Order now | Download | FAQ
v2.0 Released 23-09-2024

Module is coded ionCube v13

Supported php version:

v1.9.1 Released 13-08-2024
  1. Fixed bug with password, when "Show password" is "no"
v1.9 Released 26-06-2024
  1. Adapted to MinIO version RELEASE.2024-06-26T01-06-18Z

Attention, the module will not work with versions lower than Adapted to MinIO version RELEASE.2024-06-26T01-06-18Z

v1.8 Released 06-06-2024
  1. Client area more adapted for mobile version
  2. Buttons for copying login and password have been added to the client area
v1.7 Released 16-05-2024
  1. User blocking is disabled after the limit is reached
  2. When the limit is exhausted, the policy switches to "Raw policy Disk limit"
  3. Added functional buttons and policy management in the admin area
  4. Added a functional button for Recalculate Disk Space disk space so that the client can enable read and write rights after cleaning his disk

 After updating, you need to insert and save the "Raw policy Disk limit" in the product settings

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "admin:Heal",
                "admin:SetBucketTarget",
                "admin:TopLocksInfo",
                "admin:DataUsageInfo",
                "admin:GetBucketQuota",
                "admin:GetBucketTarget"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:DeleteObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        }
    ]
}
v1.6 Released 21-12-2023

Fixed Issues:

  1. Resolved a bug preventing the deletion of policies when an account is deleted.

Enhancements:

  1. Improved the API error logging system for enhanced diagnostics and troubleshooting.

New Features:

  1. Added functionality to disable bucket creation by default.
  2. Introduced the option to set a default bucket suffix.

Client Area Enhancements:

  1. Added the ability to disable the display of service passwords by default.
  2. Introduced a "Show" button for displaying service passwords in the Client Area.
  3. Provided options to display service passwords in plain text.

You should save the 'Module Setting' in your products for the module to function correctly.

v1.5 Released 18-12-2023
  1. Support MinIO RELEASE.2023-12-14T18-51-57Z
  2. Minor changes in the client area
v1.4 Released 11-10-2023
  1. Support MinIO RELEASE.2023-10-07T15-07-38Z
  2. Translations added/updated (Arabic, Azerbaijani, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Estonian, Farsi, French, German, Hebrew, Hungarian, Italian, Macedonian, Norwegian, Polish,  Romanian, Russian, Spanish, Swedish, Turkish, Ukrainian)
v1.3 Released 08-09-2023
  1. Support MinIO RELEASE.2023-09-07T02-05-02Z
v1.2 Released 05-03-2023
  1. Support for PHP 8.1 and PHP 7.4
  2. Support MinIO RELEASE.2023-02-22T18-23-45Z.
  3. Changes made to templates, add icons
  4. API timeout set 30
v1.1 Released 22-02-2023
  1. Support WHMCS V8.6
  2. Support for PHP 8.1 (Loader v12) and PHP 7.4
  3. Changes made to templates
  4. In the service settings, the choice of email template was changed to a drop-down menu.
  5. Added translations: German, Ukranian
  6. Updated mechanism for deleting objects, buckets, and user when terminating a service
v1.0 Released 01-08-2022

First version

Installation and configuration guide

Installation and configuration guide

1. WHMCS setup(install/update)

MinIO S3 module WHMCS 

 Order now | Download | FAQ

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-MinIO-S3/php82/PUQ_WHMCS-MinIO-S3-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/php81/PUQ_WHMCS-MinIO-S3-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/php74/PUQ_WHMCS-MinIO-S3-latest.zip

 

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/

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

Setup guide: MinIO S3 setup

MinIO S3 module WHMCS 

 Order now | Download | FAQ

There are many ways to install MinIO. Below we will introduce the installation method from binaries. In the following description, we will provide additional steps beyond the basic installation to set up the service properly. The description will include, among others, setting up the service, nginx proxy and SSL certificates.

In the current example, we will use the Debian 10 operating system.

1 - Installing and configuring the MinIO server

If you haven't updated the package database recently, update it:

sudo apt update

Then download the Minio server binary from the official website:

wget https://dl.min.io/server/minio/release/linux-amd64/minio

Output

# wget https://dl.min.io/server/minio/release/linux-amd64/minio
--2022-08-10 10:01:59-- https://dl.min.io/server/minio/release/linux-amd64/minio
Resolving dl.min.io (dl.min.io)... 178.128.69.202, 138.68.11.125
Connecting to dl.min.io (dl.min.io)|178.128.69.202|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 96968704 (92M) [application/octet-stream]
Saving to: ‘minio’

minio 100%[======================================================================>] 92,48M 16,7MB/s in 6,8s

2022-08-10 10:02:07 (13,6 MB/s) - ‘minio’ saved [96968704/96968704]

Once the download is complete, a file called minio will be in your working directory. Use the following command to get the executable:

sudo chmod +x minio

Now move the file to the /usr/local/bin directory, where the Minio systemd startup script expects to find it:

sudo mv minio /usr/local/bin

This will allow us to write a service unit file in the next steps of this tutorial to ensure that Minio starts up automatically on system boot.

For security reasons, it is recommended to avoid running the Minio server as root. This will limit the damage that can be done to the system in the event of a security breach. Because the systemd script you'll use in step 2 is looking for an account and group called minio-user, create a new user with that name:

sudo useradd -r minio-user -s /sbin/nologin

In this command, you used the -s flag to set up /sbin/nologin as the shell for minio-user. This is a shell that does not allow the user to log in, which is not necessary for minio-user.

Next, transfer ownership of the Minio binary to minio-user:

sudo chown minio-user:minio-user /usr/local/bin/minio

Next, you need to create a directory where Minio will store the files. This location will be where you store the buckets that you will use later to organize the objects you store on your Minio server. This tutorial will use the minio directory name:

sudo mkdir /usr/local/share/minio

Give minio-user ownership of this directory:

sudo chown minio-user:minio-user /usr/local/share/minio

Most server configuration files are stored in the /etc directory, so this is where you need to create your configuration file:

sudo mkdir /etc/minio

Give minio-user ownership of this directory:

sudo chown minio-user:minio-user /etc/minio

Use Nano or your favorite text editor to create the environment file needed to change the default configuration:

sudo nano /etc/default/minio

After opening the file, add the following lines to set a few important environment variables in the environment file:

MINIO_ACCESS_KEY="minio"
MINIO_VOLUMES="/usr/local/share/minio/"
MINIO_OPTS="-C /etc/minio --address :9000 --console-address :9001"
MINIO_SECRET_KEY="miniostorage"

Let's take a look at these variables and the values ​​you have set:

You have installed Minio and set a number of important environment variables. Next, you need to configure the server to run as a system service.

2 - Installing the Systemd MinIO startup script

In this step, you will set up the Minio server to manage it as a systemd service.

Create a file /etc/systemd/system/minio.service

sudo nano /etc/systemd/system/minio.service

File contents:

[Unit]
Description=MinIO
Documentation=https://docs.min.io
Wants=network-online.target
After=network-online.target
AssertFileIsExecutable=/usr/local/bin/minio

[Service]
WorkingDirectory=/usr/local/

User=minio-user
Group=minio-user

EnvironmentFile=/etc/default/minio
ExecStartPre=/bin/bash -c "if [ -z \"${MINIO_VOLUMES}\" ]; then echo \"Variable MINIO_VOLUMES not set in /etc/default/minio\"; exit 1; fi"

ExecStart=/usr/local/bin/minio server $MINIO_OPTS $MINIO_VOLUMES

# Let systemd restart this service always
Restart=always

# Specifies the maximum file descriptor number that can be opened by this process
LimitNOFILE=65536

# Disable timeout logic and wait until process is stopped
TimeoutStopSec=infinity
SendSIGKILL=no

[Install]
WantedBy=multi-user.target

# Built for ${project.name}-${project.version} (${project.name})

Then run the following command to reload all systemd units:

sudo systemctl daemon-reload
sudo systemctl enable minio

Now that the systemd script is installed and configured, it's time to start the server.

3 - Starting the MinIO Server

In this step, you will start the server and change the firewall settings to allow access through the browser interface.

Start Minio server:

sudo systemctl start minio

Then check the Minio's status, the IP address it's bound to, memory usage, and more with the following command:

sudo systemctl status minio

The result will look like this:

4 - Securing Access to MinIO Server with Let’s Encrypt SSL/TLS Certificate

 

You need to replace yourdomain.com with your own domain

Certbot is a console based certificate generation tool for Let's Encrypt.

In this recipe, we will generate a Let's Encypt certificate using Certbot. This certificate will then be deployed for use in the MinIO server.

Install Certbot

sudo apt update
sudo apt install certbot nginx python3-certbot-nginx -y

Set up Nginx proxy with MinIO Server

Proxy all requests

rm /etc/nginx/sites-enabled/default
nano /etc/nginx/sites-enabled/minio
server {
        listen 80 default_server;
        server_name yourdomain.com;
        return 301 https://$host$request_uri;
}


server {
        listen 443 ssl http2;
        server_name yourdomain.com;

        ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
        ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
        ssl_trusted_certificate /etc/letsencrypt/live/yourdomain.com/cert.pem;

        ssl_session_timeout 20m;
        ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
        ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
        ssl_prefer_server_ciphers on;
        ssl_verify_client off;

        ignore_invalid_headers off;

        client_max_body_size 0;

        proxy_buffering off;

        location / {
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header X-Forwarded-Proto $scheme;
                proxy_set_header Host $http_host;

                proxy_connect_timeout 300;
                proxy_http_version 1.1;
                proxy_set_header Connection "";
                chunked_transfer_encoding off;

                proxy_pass http://localhost:9001;
 }
}

 

Obtain the SSL/TLS Certificate

sudo certbot --nginx -d yourdomain.com

Restart nginx wer server

sudo service nginx restart

In order for the certificate to be updated automatically, you must add to the crontab

crontab -e
0 12 * * * /usr/bin/certbot renew --quiet

The configuration is now complete.
Login to the server

url: https://yourdomain.com/

For authorization, use the data that was written in the file /etc/default/minio

Username: minio
Password: miniostorage

image-1678094819285.png

 

 

 

 

Installation and configuration guide

Setup guide: WHMCS setup

MinIO S3 module WHMCS 

 Order now | Download | FAQ

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-MinIO-S3/php82/PUQ_WHMCS-MinIO-S3-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/php81/PUQ_WHMCS-MinIO-S3-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/php74/PUQ_WHMCS-MinIO-S3-latest.zip

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-MinIO-S3/

2. Unzip the archive with the module.
unzip PUQ_WHMCS-MinIO-S3-latest.zip
3. Copy and Replace "puqMinIOS3" from "PUQ_WHMCS-MinIO-S3" to "WHMCS_WEB_DIR/modules/servers/"
4. Create new server MinIO in WHMCS (System Settings->Products/Services->Servers)
System Settings->Servers->Add New Server

image-1660047004719.png

image-1660047051935.png

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

In the Module settings section, select the "PUQ MinIOS3" module

image-1660047236549.png

 

 Example:

In the given policy example. The user has the right to create buckets with a name starting with the username.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "admin:Heal",
                "admin:SetBucketTarget",
                "admin:TopLocksInfo",
                "admin:DataUsageInfo",
                "admin:GetBucketQuota",
                "admin:GetBucketTarget"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:*"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        }
    ]
}

 

 

 

Installation and configuration guide

Email Template (puqMinIOS3 Notification disk limit)

MinIO S3 module WHMCS 

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

image-1660046643096.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}

image-1660046719699.png

Installation and configuration guide

Email Template (puqMinIOS3 service Suspension Notification disk limit)

MinIO S3 module WHMCS 

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

image-1660046825751.png

Subject: 

Suspension Information - {$username}

Body:

Dear {$client_name},

This email informs you that the S3 account has been disabled due to running out of free space.

It is also possible to upgrade to a package with more space.

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}

 

image-1660046885278.png

Installation and configuration guide

Add server (MinIO S3)

MinIO S3 module WHMCS 

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

image-1660047004719.png

image-1660047051935.png

 

Installation and configuration guide

Product Configuration

MinIO S3 module WHMCS 

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

In the Module settings section, select the "PUQ MinIOS3" module

image-1715789105588.png

 Example:

In the given policy example. The user has the right to create buckets with a name starting with the username.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "admin:Heal",
                "admin:SetBucketTarget",
                "admin:TopLocksInfo",
                "admin:DataUsageInfo",
                "admin:GetBucketQuota",
                "admin:GetBucketTarget"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:*"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        }
    ]
}
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "admin:Heal",
                "admin:SetBucketTarget",
                "admin:TopLocksInfo",
                "admin:DataUsageInfo",
                "admin:GetBucketQuota",
                "admin:GetBucketTarget"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:DeleteObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::<USER_ID>*"
            ]
        }
    ]
}

Attention, policy recalculation occurs once a day during the collection of server statistics (UpdateServerUsage)

 

 

 

 

 

 

 

 

 

 

 

 

 

Client Area

Client Area

Home screen

MinIO S3 module WHMCS 

 Order now | Download | FAQ

The end customer, after logging in to his own customer panel, has access to the following information and options:

Screenshot when the account is in a normal state.

image-1717715952818.png

Screenshot when the account is limited due to limit overflow.

image-1678097515190.png

 

image-1715816400821.png

Recalculate Disk Space: so that the client can enable read and write rights after cleaning his disk

image-1717716002153.png

image-1717716051795.png

Client Area

Email notification

MinIO S3 module WHMCS 

 Order now | Download | FAQ
Below you can see an example of an email notification regarding data limit

image-1660048492905.png

Client Area

Disk statistics

MinIO S3 module WHMCS 

 Order now | Download | FAQ

Client can check the data usage statistics in the menu item "Used space statistics"

image-1660042692052.png

image-1660048208981.png

Admin Area

Admin Area

Product Information

MinIO S3 module WHMCS 

 Order now | Download | FAQ
Here is the data presented for the service admin in WHMCS

image-1715816535161.png

The "Update Policy" button is used to force the system to select and apply the necessary policy. If there is more than 0 free space on the disk, a permissive policy will be applied; if there is 0 free space on the disk, a restrictive policy will be applied.

The "Set Standard Policy" and "Set Limited Policy" buttons respectively enforce the application of the standard policy and the limited policy.


Attention, policy recalculation occurs once a day during the collection of server statistics (UpdateServerUsage)