Installation
Install Uptime Monitor 2
This page is the first install for a WHMCS administrator. The encoded package needs ionCube Loader on the PHP version that runs WHMCS. Activation creates the database tables. No manual SQL is required.
Step 1 — Upload the Addon Files
- Download the Uptime Monitor 2 ZIP package from your ServLayer client area.
- Extract the archive. You will find a folder named
UptimeMonitor2. - Upload the
UptimeMonitor2folder to:/path/to/whmcs/modules/addons/UptimeMonitor2/ - If using the Status Page Pro extension, also upload the
extensions/folder contents into:/path/to/whmcs/modules/addons/UptimeMonitor2/extensions/ - For the standalone status page, upload
status.phpto the WHMCS root:/path/to/whmcs/status.php
Note
The addon folder must be named exactly UptimeMonitor2 (case-sensitive) for WHMCS to detect it.
Step 2 — Activate the Addon in WHMCS
- Log in to the WHMCS admin panel.
- Navigate to Setup → Addon Modules.
- Find Uptime Monitor 2 in the list and click Activate.
- The addon creates all required database tables automatically during activation.
- Assign admin role access if prompted.
Step 3 — Enter Your License Key
- Go to Setup → Addon Modules → Uptime Monitor 2 → Configure.
- Enter your license key in the License Key field. Keys start with
SRV-UM2-. - Click Save Changes.
Alternatively, configure the license key inside the addon:
- Open Admin → Addons → Uptime Monitor 2.
- Go to Settings → License.
- Enter the key and click Save License Key.
- Click Force Check to verify immediately.
[!IMPORTANT] The license key must be active on the ServLayer license server and the domain/IP of your WHMCS installation must match the registered binding. If you move to a new server, contact ServLayer support to reissue the key.
Step 4 — Configure the Cron Job
Uptime Monitor 2 relies on the WHMCS cron job to run checks automatically.
The WHMCS cron (crons/cron.php) should run every minute or at least every 5 minutes.
For faster check execution, you can also configure the dedicated cron URL:
- Go to Settings → Cron inside the addon.
- Copy the Cron URL (it includes a security token).
- Add a system cron entry that calls this URL at your desired interval:
*/5 * * * * curl -s "https://yourwhmcs.com/index.php?m=UptimeMonitor2&action=cron&token=YOUR_TOKEN" > /dev/null
Tip
Using the dedicated cron URL in addition to the WHMCS cron ensures checks run reliably even if the WHMCS cron is under load.
Step 5 — Post-Installation Verification
After installation, verify the following:
| Check | Expected result |
|---|---|
| Addon visible in WHMCS admin | Admin → Addons → Uptime Monitor 2 opens |
| Database tables created | No errors on activation |
| License status | Settings → License shows Active |
| Cron working | Tools → Force Run All returns results |
| Status page loads | Visit the status page URL in a browser |
Warning
If the license shows Version Blocked, your installed version is not registered on the license server. Contact ServLayer support.
Upgrading from a Previous Version
- Replace all files in
modules/addons/UptimeMonitor2/with the new version. - Replace extension files in
extensions/if extensions were updated. - Open the addon admin once — the schema migration runs automatically.
- No manual database changes are required.
Caution
Do not delete the modules/addons/UptimeMonitor2/ folder and recreate it. Use Deactivate only when you intend to remove the data.
Next
Continue with the post-install checklist.