How to install Caddie for WHMCS Print

  • whmcs, caddie, client tools, addon, license key, install
  • 0

Caddie adds 24 website, DNS, email, monitoring and business tools to your WHMCS client area, including uptime monitors with email alerts.

Before you start

  • WHMCS 9.0 or newer and PHP 8.3 or newer
  • ionCube Loader v15 or newer, plus the cURL, OpenSSL, mbstring, ZipArchive and SimpleXML PHP extensions
  • Your license key and the download, both on the product page under Services → My Services in our client area

Install it

  1. Upload the caddie folder from the zip into modules/addons/ in your WHMCS install.
  2. Go to Configuration → System Settings → Addon Modules, find Caddie and click Activate.
  3. Click Configure and fill in:
    • License Key
    • Access Control: the admin roles that should see Caddie
    • Hosting Plans URL, Reseller Plans URL and Web Design URL. The tools' "we can do this for you" links point here.
    • Optional: a free Google PageSpeed API key for the Core Web Vitals tool
  4. Save.

Make sure the WHMCS cron is running

Uptime checks and heartbeat alerts run with the WHMCS cron every 5 minutes. Check it under Configuration → System Settings → Automation Settings.

For faster heartbeat alerts, you can add an extra cron job that runs every minute:

* * * * * php -q /path/to/whmcs/modules/addons/caddie/cron.php

Choose who can use it

Under Addons → Caddie you can let any logged-in client use the tools, only clients with an active service, or only clients with certain products. You can also turn single tools on or off.

Clients find the tools at index.php?m=caddie, from the Web Tools menu link and from a panel on the client homepage.

Using a Zomex theme like Prosper? In templates/YOUR-THEME/includes/submenu-whmcs.tpl, add || $smarty.get.m eq "caddie" before the closing } of the long {if ...} on line 3 so the client menu shows on Caddie pages. Re-apply it after theme updates.

Was this answer helpful?

« Back