kb / hosting-quota-notification-install

Install & activate the Hosting quota notification WHMCS module

Installation procedure

  1. Download the latest Hosting quota notification module zip file from your client area.
  2. Extract the modules folder into the root of your WHMCS installation.
  3. Overwrite any files or folders that already exist.
  4. The key.txt file must be writable by the web server.

Configuration

  1. Activate the addon using the WHMCS Addon page (WHMCS Admin → Setup → Addon modules → click Activate next to the Hosting quota notification module).

  2. Click Configuration.

  3. Enter your licence information.

  4. Enter the username of an admin account with API access permission (not needed since version 2.4).

  5. Choose the appropriate settings for notifications and suspension.

  6. Choose the admin role groups permitted to access the Hosting quota notification module.

  7. Save settings.

  8. Edit the email template Disk Quota Warning as needed. To show hosting usage and limits:

    • {$hosting_percentage} - used disk percentage (number only)
    • {$hosting_usage} - disk usage in megabytes (number only)
    • {$hosting_quota} - web hosting package disk limit in megabytes (number only)

  9. Edit the email template Bandwidth Quota Warning as needed. To show bandwidth usage and limits:

    • {$bw_percentage} - used bandwidth percentage (number only)
    • {$bw_usage} - bandwidth usage in megabytes (number only)
    • {$bw_quota} - hosting package bandwidth limit in megabytes (number only)

The module runs automatically each time the WHMCS cron job runs.