How to Automatically Backup WHMCS to S3 | Auto Backup Manager S3 Setup Guide

Auto Backup Manager S3 – Installation & Setup Guide

This guide explains how to install and configure the Auto Backup Manager S3 module in WHMCS. The module allows administrators to automate server backups and store them securely in S3-compatible cloud storage.

1. Requirements

Before installing the module, ensure your system meets the following requirements:

• WHMCS 8.x or newer
• PHP 7.4 or later
• Cron job access on your server
• An S3-compatible storage account
• Valid Access Key and Secret Key

2. Module Installation

Step 1 – Upload Module Files

1. Download the module package.
2. Extract the archive file.
3. Upload the module folder to the following directory:

/modules/addons/

The final structure should look like this:

/modules/addons/autobackupmanagers3

Step 2 – Activate the Module

1. Log in to your WHMCS Admin Area.
2. Navigate to:

System Settings > Addon Modules

3. Find Auto Backup Manager S3.
4. Click Activate.

Step 3 – Configure Administrator Permissions

1. Assign access permissions to administrator roles.
2. Select the administrator groups that should access the module.
3. Click Save Changes.

3. Storage Configuration (S3)

Navigate to the module dashboard:

Addons > Auto Backup Manager S3

Fill in the required storage settings:

• Bucket Name
• Endpoint URL
• Region
• Access Key
• Secret Key

Test Connection

After entering the configuration details, click Test Connection. If the configuration is correct, the system will confirm that the connection is successful.

4. Configure Backup Settings

The module allows several backup configuration options including:

• Backup file storage location
• Chunk upload size
• Backup retention policy
• Email notification settings

Chunk Upload Configuration

Chunk upload improves reliability when uploading large backup files.

Chunk Size (MB)

Example values:

5 MB
10 MB
100 MB

5. Configure Cron Job

To automate backups, configure a cron job on your server.

Method 1 – CLI Command

php /path/to/whmcs/modules/addons/autobackupmanagers3/cron.php

Recommended schedule: Daily

Method 2 – Wget Command

wget -q -O - https://yourdomain.com/modules/addons/autobackupmanagers3/cron.php

Method 3 – PHP Script Execution

php cron.php

Cron Job Schedule Examples

Cron jobs allow you to run commands or scripts automatically at scheduled times on Linux or Unix servers.

Every 5 Minutes

*/5 * * * *

Runs the cron job every 5 minutes.

Every 10 Minutes

*/10 * * * *

Runs the cron job every 10 minutes.

Every 30 Minutes

*/30 * * * *

Runs the cron job every 30 minutes.

Every Hour

0 * * * *

Runs the cron job once every hour.

Every 6 Hours

0 */6 * * *

Runs the cron job every 6 hours.

Every 12 Hours

0 */12 * * *

Runs the cron job every 12 hours.

Daily

0 0 * * *

Runs the cron job once per day at midnight.

Weekly

0 0 * * 0

Runs the cron job once per week (Sunday).

Monthly

0 0 1 * *

Runs the cron job on the first day of each month.

Yearly

0 0 1 1 *

Runs the cron job once per year on January 1.

6. Run Backup Manually

If you want to create a backup immediately:

1. Open the module dashboard.
2. Click Run Backup Now.

This will start the backup process instantly.

7. Managing Backup Files

All backup files can be managed through the File Manager section.

• Restore – Restore backup data
• Download – Download backup files
• Delete – Remove backup files

8. Backup Logs

The Logs History section records backup activity including:

• Backup execution date
• Backup type
• File size
• Storage path

9. Email Notifications

Email notifications can be configured to alert administrators when:

• A backup completes successfully
• A backup process fails
• An error occurs during upload

10. Troubleshooting

Connection Test Failed

• Check Access Key and Secret Key
• Verify Bucket permissions
• Confirm Endpoint URL
• Confirm Region configuration

Backup Upload Failed

• Check network connectivity
• Verify storage credentials
• Ensure storage permissions are correct

11. Best Practices

• Schedule backups during low server activity
• Monitor backup logs regularly
• Test restore functionality periodically
• Use retention policies to control storage usage