Skip to content
Intally

Quick start

Quick start

Client Resource Dashboard surfaces real-time hosting resource usage (disk / bandwidth / CPU / memory) inside the WHMCS client area, so hosts don't have to roll their own data scraper. cPanel / Plesk / DirectAdmin are supported out of the box. This guide covers install, first data scrape, and Pro features (alerts / heatmap).

For WHMCS hosting providers who want to give clients resource-usage transparency.

1. Install and activate

  1. Download the ZIP matching your PHP version (e.g. client_resource_dashboard_v1.x.x_php8.1.zip) and extract into your WHMCS root.
  2. WHMCS admin → Setup → Apps & Integrations → Client Resource Dashboard → Activate.
  3. Configuration → Addon Modules → Client Resource Dashboard → tick admin roles allowed access (Full Administrator recommended) + paste your license key (Pro features only) + Save.
  4. Top menu Addons → Client Resource Dashboard opens the console.

Activation creates mod_crd_cache / mod_crd_alert_log tables for cached resource data.

2. Dashboard

The dashboard shows:

  • Number of monitored services (cache rows)
  • Alerts in the last 24 hours
  • 10 most recent alert entries
  • Feature matrix (Free vs Pro)

3. Data scraping

A cron job (default every 15 minutes, configurable) calls cPanel / Plesk / DirectAdmin APIs to fetch each hosting service's current usage: - Disk used / total - Bandwidth used / total (monthly) - CPU / memory (if panel supports it)

Data is cached in mod_crd_cache; the client-area widget reads from cache (never blocks the client page).

4. Client-area widget

Any WHMCS client visiting their "My Service" detail page automatically sees the resource panel:

  • 4 progress bars (disk / bandwidth / CPU / memory)
  • Color thresholds: < 60% green / 60-80% yellow / > 80% red
  • "Upgrade plan" button (highlighted at 80%+)

5. Heatmap (Pro)

The Heatmap page:

  • Resource grid grouped by server
  • Each cell = one hosting account, colored by usage heat
  • Hover for exact numbers
  • Quickly locate "heavy users"

6. Alert rules (Pro)

Settings page → alert thresholds:

  • Default 80% / 90% / 95%
  • Trigger condition: must exceed for N consecutive scrapes (suppresses spikes)
  • Channels: email (Pro adds webhook)

Each alert is logged in mod_crd_alert_log; the dashboard shows "Recent alerts".

7. Settings (Pro)

The Settings page:

  • Cron frequency (default 15 min, minimum 5 min)
  • Alert thresholds
  • Retention days (Free 7 / Pro 90)
  • Notification channel credentials

8. Auto-updates

With a valid license, the right-side "Check for Updates" panel fetches the latest version; "Install Update" runs the WHMCS standard update flow.

9. FAQ

Q: What's free vs Pro? A: Free: single-server + dashboard + client widget + 7-day retention. Heatmap, alert rules, multi-server panel scale need Pro.

Q: Which control panels are supported? A: cPanel (WHM API), Plesk (REST API), DirectAdmin. Other panels can be added via custom hook.

Q: Will frequent scraping hit panel rate limits? A: Default 15 min — adjust as needed. Each scrape is a single API call per server; cPanel WHM defaults to 100 req/min, far above plugin needs.

Q: Does the client widget slow down the client area? A: The client widget reads mod_crd_cache (indexed), no remote API calls, sub-millisecond.

For deeper docs (per-panel API endpoints, cache strategy, table schema) see the "Full documentation" link on your store dashboard card.